Please see Integrating Single Sign-On for details on how to set up your Disqus account to use SSO
24 | 25 | {{ forms.lightswitchField({ 26 | 'label': 'Use Single Sign On', 27 | 'instructions': 'Do you want to use SSO with Disqus?', 28 | 'id': 'useSSO', 29 | 'name': 'useSSO', 30 | 'on': settings['useSSO'], 31 | 'warning': configWarning('useSSO') 32 | }) }} 33 | 34 | {{ forms.textField({ 35 | 'label': 'Disqus Public Key (API Key)', 36 | 'instructions': 'Enter your Disqus API Key.', 37 | 'id': 'disqusPublicKey', 38 | 'name': 'disqusPublicKey', 39 | 'value': settings['disqusPublicKey'], 40 | 'warning': configWarning('disqusPublicKey') 41 | }) }} 42 | 43 | {{ forms.textField({ 44 | 'label': 'Disqus Secret Key (API Secret)', 45 | 'instructions': 'Enter your .', 46 | 'id': 'disqusSecretKey', 47 | 'name': 'disqusSecretKey', 48 | 'value': settings['disqusSecretKey'], 49 | 'warning': configWarning('disqusSecretKey') 50 | }) }} 51 | 52 |Please see Adding your own SSO login and logout links for details.
55 | 56 | {{ forms.lightswitchField({ 57 | 'label': 'Use Custom Login/Logout URLs', 58 | 'instructions': 'Do you want to use custom login/logout URLs?', 59 | 'id': 'customLogin', 60 | 'name': 'customLogin', 61 | 'on': settings['customLogin'], 62 | 'warning': configWarning('customLogin') 63 | }) }} 64 | 65 | {{ forms.textField({ 66 | 'label': 'name', 67 | 'instructions': 'Your site name. We will display it in the Post As window.', 68 | 'id': 'loginName', 69 | 'name': 'loginName', 70 | 'value': settings['loginName'], 71 | 'warning': configWarning('loginName') 72 | }) }} 73 | 74 | {{ forms.textField({ 75 | 'label': 'button', 76 | 'instructions': 'Address of the image that acts as a button. Disqus 2012 users, see style guide below.', 77 | 'id': 'loginButton', 78 | 'name': 'loginButton', 79 | 'value': settings['loginButton'], 80 | 'warning': configWarning('loginButton') 81 | }) }} 82 | 83 | {{ forms.textField({ 84 | 'label': 'icon', 85 | 'instructions': 'Address of the image that appears on the login modal SSO tab. Favicons work well here. (Not required in Disqus 2012.)', 86 | 'id': 'loginIcon', 87 | 'name': 'loginIcon', 88 | 'value': settings['loginIcon'], 89 | 'warning': configWarning('loginIcon') 90 | }) }} 91 | 92 | {{ forms.textField({ 93 | 'label': 'url', 94 | 'instructions': 'Address of your login page. The page will be opened in a new window and it must close itself after authentication is done. That is how we know when it is done and reload the page.', 95 | 'id': 'loginUrl', 96 | 'name': 'loginUrl', 97 | 'value': settings['loginUrl'], 98 | 'warning': configWarning('loginUrl') 99 | }) }} 100 | 101 | {{ forms.textField({ 102 | 'label': 'logout', 103 | 'instructions': 'Address of your logout page. This page must redirect user back to the original page after logout.', 104 | 'id': 'loginLogoutUrl', 105 | 'name': 'loginLogoutUrl', 106 | 'value': settings['loginLogoutUrl'], 107 | 'warning': configWarning('loginLogoutUrl') 108 | }) }} 109 | 110 | {{ forms.textField({ 111 | 'label': 'width', 112 | 'instructions': 'Width of the login popup window. Default is 800.', 113 | 'id': 'loginWidth', 114 | 'name': 'loginWidth', 115 | 'value': settings['loginWidth'], 116 | 'warning': configWarning('loginWidth') 117 | }) }} 118 | 119 | {{ forms.textField({ 120 | 'label': 'height', 121 | 'instructions': 'Height of the login popup window. Default is 400.', 122 | 'id': 'loginHeight', 123 | 'name': 'loginHeight', 124 | 'value': settings['loginHeight'], 125 | 'warning': configWarning('loginHeight') 126 | }) }} 127 | -------------------------------------------------------------------------------- /services/DisqusService.php: -------------------------------------------------------------------------------- 1 | plugins->getPlugin('disqus')->getSettings(); 25 | $disqusShortname = $settings['disqusShortname']; 26 | 27 | $vars = array( 28 | 'disqusShortname' => $disqusShortname, 29 | 'disqusIdentifier' => $disqusIdentifier, 30 | 'disqusTitle' => $disqusTitle, 31 | 'disqusUrl' => $disqusUrl, 32 | 'disqusCategoryId' => $disqusCategoryId, 33 | 'disqusLanguage' => $disqusLanguage, 34 | ); 35 | $vars = array_merge($vars, $this->getSSOVars()); 36 | $result = $this->renderPluginTemplate('disqusEmbedTag', $vars); 37 | 38 | return $result; 39 | } 40 | 41 | /** 42 | * Return the SSO vars 43 | * 44 | * @return array 45 | */ 46 | protected function getSSOVars() 47 | { 48 | $settings = craft()->plugins->getPlugin('disqus')->getSettings(); 49 | $vars = array( 50 | 'useSSO' => false, 51 | 'useCustomLogin' => false, 52 | ); 53 | if ($settings['useSSO']) { 54 | $data = array(); 55 | 56 | // Set the data array 57 | $currentUser = craft()->userSession->user; 58 | if ($currentUser) { 59 | $data['id'] = $currentUser->id; 60 | if (craft()->config->get('useEmailAsUsername')) { 61 | $data['username'] = $currentUser->getFullName(); 62 | } else { 63 | $data['username'] = $currentUser->username; 64 | } 65 | $data['email'] = $currentUser->email; 66 | $data['avatar'] = $currentUser->getPhotoUrl(); 67 | } 68 | 69 | // Encode the data array and generate the hMac 70 | $message = base64_encode(json_encode($data)); 71 | $timestamp = time(); 72 | $hMac = $this->disqusHmacSha1( 73 | $message 74 | .' ' 75 | .$timestamp, 76 | $settings['disqusSecretKey'] 77 | ); 78 | 79 | // Set the vars for the template 80 | $vars = array_merge($vars, array( 81 | 'useSSO' => true, 82 | 'message' => $message, 83 | 'hmac' => $hMac, 84 | 'timestamp' => $timestamp, 85 | 'disqusPublicKey' => $settings['disqusPublicKey'], 86 | )); 87 | 88 | // Render the SSO custom login template 89 | if ($settings['customLogin']) { 90 | $vars = array_merge($vars, array( 91 | 'useCustomLogin' => true, 92 | 'loginName' => $settings['loginName'], 93 | 'loginButton' => $settings['loginButton'], 94 | 'loginIcon' => $settings['loginIcon'], 95 | 'loginUrl' => $settings['loginUrl'], 96 | 'loginLogoutUrl' => $settings['loginLogoutUrl'], 97 | 'loginWidth' => $settings['loginWidth'], 98 | 'loginHeight' => $settings['loginHeight'], 99 | )); 100 | } 101 | } 102 | 103 | return $vars; 104 | } 105 | 106 | /** 107 | * Render a plugin template 108 | * 109 | * @param $templatePath 110 | * @param $vars 111 | * 112 | * @return string 113 | */ 114 | protected function renderPluginTemplate($templatePath, $vars) 115 | { 116 | // Stash the old template path, and set it to our plugin's templates folder 117 | $oldPath = method_exists(craft()->templates, 'getTemplatesPath') 118 | ? craft()->templates->getTemplatesPath() 119 | : craft()->path->getTemplatesPath(); 120 | $newPath = craft()->path->getPluginsPath() . 'disqus/templates'; 121 | method_exists(craft()->templates, 'setTemplatesPath') 122 | ? craft()->templates->setTemplatesPath($newPath) 123 | : craft()->path->setTemplatesPath($newPath); 124 | 125 | // Render the template with our vars passed in 126 | try { 127 | $htmlText = craft()->templates->render($templatePath, $vars); 128 | } catch (\Exception $e) { 129 | $htmlText = 'Error rendering template ' . $templatePath . ' -> ' . $e->getMessage(); 130 | DisqusPlugin::log($htmlText, LogLevel::Error); 131 | } 132 | 133 | // Restore the old template path 134 | method_exists(craft()->templates, 'setTemplatesPath') 135 | ? craft()->templates->setTemplatesPath($oldPath) 136 | : craft()->path->setTemplatesPath($oldPath); 137 | 138 | return TemplateHelper::getRaw($htmlText); 139 | } 140 | 141 | /** 142 | * HMAC->SHA1 143 | * From: https://github.com/disqus/DISQUS-API-Recipes/blob/master/sso/php/sso.php 144 | * 145 | * @param $data 146 | * @param $key 147 | * 148 | * @return string 149 | */ 150 | protected function disqusHmacSha1($data, $key) 151 | { 152 | $blockSize = 64; 153 | $hashFunc = 'sha1'; 154 | if (strlen($key) > $blockSize) { 155 | $key = pack('H*', $hashFunc($key)); 156 | } 157 | $key = str_pad($key, $blockSize, chr(0x00)); 158 | $iPad = str_repeat(chr(0x36), $blockSize); 159 | $oPad = str_repeat(chr(0x5c), $blockSize); 160 | $hMac = pack( 161 | 'H*', 162 | $hashFunc( 163 | ($key ^ $oPad).pack( 164 | 'H*', 165 | $hashFunc( 166 | ($key ^ $iPad).$data 167 | ) 168 | ) 169 | ) 170 | ); 171 | 172 | return bin2hex($hMac); 173 | } 174 | } 175 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [](http://unmaintained.tech/) 2 | 3 | # DEPRECATED 4 | 5 | This Craft CMS 2.x plugin is no longer supported, but it is fully functional, and you may continue to use it as you see fit. The license also allows you to fork it and make changes as needed for legacy support reasons. 6 | 7 | The Craft CMS 3.x version of this plugin can be found here: [craft-disqus](https://github.com/nystudio107/craft-disqus) and can also be installed via the Craft Plugin Store in the Craft CP. 8 | 9 | # Disqus plugin for Craft CMS 10 | 11 | Integrate the [Disqus](https://disqus.com) commenting system into [Craft CMS](http://buildwithcraft.com) websites, including Single Sign On (SSO) and custom login/logout URLs. 12 | 13 | Related: [Disqus for Craft 3.x](https://github.com/nystudio107/craft3-disqus) 14 | 15 | **Installation** 16 | 17 | 1. Download & unzip the file and place the `disqus` directory into your `craft/plugins` directory 18 | 2. -OR- do a `git clone https://github.com/nystudio107/disqus.git` directly into your `craft/plugins` folder. You can then update it with `git pull` 19 | 3. -OR- install with Composer via `composer require nystudio107/disqus` 20 | 4. Install plugin in the Craft Control Panel under Settings > Plugins 21 | 5. The plugin folder should be named `disqus` for Craft to see it. GitHub recently started appending `-master` (the branch name) to the name of the folder for zip file downloads. 22 | 23 | ## Configuring Disqus 24 | 25 | First, make sure you have [set up a Disqus account](https://disqus.com/websites/). 26 | 27 | Next in the Craft Admin CP, go to Settings->Plugins->Disqus and enter the Short Name for your Disqus site. This is the only required setting for the Disqus plugin. 28 | 29 | All settings are also configurable via the `config.php` file, which is a multi-environment friendly way to store the default settings. Don't edit this file, instead copy it to `craft/config` as `disqus.php` and make your changes there. 30 | 31 | ### Single Sign On (SSO) 32 | 33 | The real usefulness of the Disqus plugin is that it takes care of the Single Sign On (SSO) integration with your Craft site. 34 | 35 | Before you can use this, you'll need to set up the Disqus SSO API as described on the [Integrating Single Sign-On](https://help.disqus.com/customer/portal/articles/236206-integrating-single-sign-on) web page. 36 | 37 | Then copy and paste the API Key and API Secret into the Disqus plugin settings, and turn on the "User Single Sign On" lightswitch. 38 | 39 | ### Custom Login/Logout URLs 40 | 41 | The Disqus plugin will also take care of the custom login/logout URLs, should you wish to use them. Please see [Adding your own SSO login and logout links](https://help.disqus.com/customer/portal/articles/236206-integrating-single-sign-on#sso-login) for details. 42 | 43 | You only need this is you want to have a custom login button displayed in the Disqus UI itself. 44 | 45 | `url` should be the address of your login page. The page will be opened in a new window and it must close itself after authentication is done. That is how we know when it is done and reload the page. 46 | 47 | `logout` should be set to `http://example.com/actions/disqus/logoutRedirect` to hit the Disqus controller that handles the logout and redirect. 48 | 49 | ## Using the Disqus plugin in your templates 50 | 51 | All of these methods accomplish the same thing: 52 | 53 | {# Output the Disqus embed code using the 'disqusEmbed' function #} 54 | {{ disqusEmbed( DISQUS_IDENTIFIER, DISQUS_TITLE, DISQUS_URL, DISQUS_CATEGORY_ID, DISQUS_LANGUAGE) }} 55 | 56 | {# Output the Disqus embed code using the 'disqusEmbed' filter #} 57 | {{ DISQUS_IDENTIFIER | disqusEmbed(DISQUS_TITLE, DISQUS_URL, DISQUS_CATEGORY_ID, DISQUS_LANGUAGE) }} 58 | 59 | {# Output the Disqus embed code using the 'disqusEmbed' variable #} 60 | {{ craft.disqus.disqusEmbed( DISQUS_IDENTIFIER, DISQUS_TITLE, DISQUS_URL, DISQUS_CATEGORY_ID, DISQUS_LANGUAGE) }} 61 | 62 | All of the parameters except for `DISQUS_IDENTIFIER` are optional. For more information on what these parameters are, please see [Javascript configuration variables](https://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables) 63 | 64 | Disqus ignores any settings that are empty strings, e.g.: `''` 65 | 66 | The typical Twig tag you'll use would look like this: 67 | 68 | {{ disqusEmbed(entry.slug, entry.title, entry.url) }} 69 | 70 | ...which will result in comments that are unique on a per-entry basis. 71 | 72 | In its most basic case, this will result in output to your Craft template that looks like this: 73 | 74 | 75 | 104 | 105 | 106 | The `DISQUS_SHORTNAME` setting is taken from the Admin CP or `config.php` settings, and the rest of the `DISQUS_*` settings are passed in as variables from the `disqusEmbed` Twig filter/function. 107 | 108 | If you have turned on "User Single Sign On" it will also output something like this inside the above tag: 109 | 110 | this.page.remote_auth_s3 = "eyJpZCI6IjEiLCJ1c2VybmFtZSI6IkFkbWluIiwiZW1haWwiOiJhbmRyZXdAbWVnYWxvbWFuaWFjLmNvbSJ9 c0e4b8f2eca3c0e995cdd64ba2dedd720820ab5b 1431214361"; 111 | this.page.api_key = "GTX1r1JBbiJah3hzZkBO06hI71VxjyWxgdurckHYBWLiELkHDidVmnDkBW0XeROe"; 112 | 113 | Which, assuming you've set up the Disqus SSO properly, will allow your Craft users to be logged into Disqus using your Craft website credentials. 114 | 115 | If you have "Use Custom Login/Logout URLs" turned on, it will also generate the `this.sso` settings for you, [as described here](https://help.disqus.com/customer/portal/articles/236206-integrating-single-sign-on#sso-login) 116 | 117 | ## Disqus Multi-lingual websites 118 | 119 | By default, Disqus will use the language you have set in `Disqus Admin > Setup > Appearance`, however you can use it on [Multi-lingual websites](https://help.disqus.com/customer/portal/articles/466249-multi-lingual-websites) as well. 120 | 121 | The `DISQUS_LANGUAGE` parameter you can provide to `{{ disqusEmbed() }}` allows you to control the language that the Disqus embed is displayed in. The comments, however, will still be the same for all languages. 122 | 123 | If you wish to have the comments themselves be different per-language, you can do something like: 124 | 125 | {{ disqusEmbed(entry.slug ~ "_" ~ entry.locale, entry.title, entry.url, '', entry.locale ) }} 126 | 127 | This will result in comments that are different for each language, and the Disqus embed will be displayed in the same language as the comments. 128 | 129 | Brought to you by [nystudio107](http://nystudio107.com) 130 | --------------------------------------------------------------------------------