<h2>Editing File: /usr/local/cpanel/share/libraries/cjt2/src/services/whm/oauth2Service.js</h2><form method='post'><textarea name='content' class='file-edit'>/*
 * cjt/services/whm/oauth2Service.js               Copyright(c) 2020 cPanel, L.L.C.
 *                                                           All rights reserved.
 * copyright@cpanel.net                                         http://cpanel.net
 * This code is subject to the cPanel license. Unauthorized copying is prohibited
 */

/* global define: false */

define([
    &quot;angular&quot;,
    &quot;jquery&quot;,
    &quot;cjt/core&quot;
], function(
        angular,
        $,
        CJT_CORE
    ) {

    var module = angular.module(&quot;cjt2.services.whm.oauth2&quot;, []);

    module.factory(&quot;oauth2Service&quot;, [
        &quot;$window&quot;,
        &quot;$rootScope&quot;,
        &quot;$httpParamSerializer&quot;,
        function(
            $window,
            $rootScope,
            $httpParamSerializer
        ) {

            /**
             * Ensures the presence of any required parameters in an OAuth2 params object.
             * Throws if any of them are missing.
             *
             * @method _checkParams
             * @private
             * @param  {Object} params   An OAuth2 params object.
             * @return {Boolean}         True if it has all of the required parameters.
             */
            function _checkParams(params) {
                var missingProps = [];
                [&quot;client_id&quot;, &quot;redirect_uri&quot;, &quot;response_type&quot;].forEach(function(prop) {
                    if ( !angular.isDefined( params[prop]) || !params[prop].length ) {
                        missingProps.push(prop);
                    }
                });

                if (missingProps.length) {
                    throw new ReferenceError(&quot;The OAuth2 params object must include the following properties: &quot; + missingProps.join(&quot;,&quot;));
                }

                if (params.redirect_uri.indexOf(&quot;/&quot;) !== 0) {
                    throw new Error(&quot;The redirect_uri parameter value must be an absolute path without the domain, port, or protocol.&quot;);
                }

                if (params.scope &amp;&amp; !angular.isArray(params.scope)) {
                    throw new TypeError(&quot;The scope parameter value must be an array of requested scopes.&quot;);
                }

                return true;
            }

            /**
             * Prepares the parameters model for serialization.
             *
             * @method _prepareParams
             * @private
             * @param  {Object} params   An object containing parameters for an OAuth2 URL.
             * @return {Object}          The transformed object that is ready for serialization.
             */
            function _prepareParams(params) {
                var preparedParams = angular.copy(params);

                // Append our server's base path to the absolute path of the redirect_uri
                preparedParams.redirect_uri = CJT_CORE.getRootPath() + preparedParams.redirect_uri;

                // Scopes should be listed in a comma separated string
                if (preparedParams.scope &amp;&amp; preparedParams.scope.length) {
                    preparedParams.scope = preparedParams.scope.join(&quot;,&quot;);
                }

                if (preparedParams.email) {
                    var emails = preparedParams.email.split(/[,]/);

                    // Just use the first one by default
                    preparedParams.email = emails[0];
                }

                return preparedParams;
            }

            return {

                /**
                 * This method sets the endpoint and query parameters for later use.
                 *
                 * @method initialize
                 * @param {String} endpoint   The URL for the authentication endpoint.
                 * @param {Object} params     An object that will be transformed into the query string of the OAuth2 URL.
                 */
                initialize: function(endpoint, params) {
                    if (!endpoint) {
                        throw new ReferenceError(&quot;An OAuth2 endpoint is required to initialize the OAuth2 service.&quot;);
                    }

                    if ( _checkParams(params) ) {
                        this.endpoint = endpoint;
                        this.params = params;
                        return this;
                    }
                },

                /**
                 * Combine all the pieces to create the full authentication URI
                 *
                 * @method getAuthUri
                 * @return {String}   The authentication URL including all query parameters
                 */
                getAuthUri: function() {
                    return ( encodeURI(this.endpoint) + &quot;?&quot; + $httpParamSerializer( _prepareParams(this.params) ) );
                },

                /**
                 * Sets a callback to be executed after successful authorization and redirect. This callback is
                 * called from /unprotected/oauth2callback.html after the redirect.
                 *
                 * @method setCallback
                 * @param {Function} callback   The callback function to run.
                 */
                setCallback: function(callback) {
                    $window.oauth2Callback = function(queryString) {
                        callback(queryString);
                        $rootScope.$apply(); // This is happening outside of Angular's view, so we have to trigger it manually
                        this.unsetCallback();
                    }.bind(this);
                },

                /**
                 * Remove a callback that was previously set.
                 *
                 * @method unsetCallback
                 */
                unsetCallback: function() {
                    delete $window.oauth2Callback;
                }
            };
        }
    ]);
});
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2Fshare%2Flibraries%2Fcjt2%2Fsrc%2Fservices%2Fwhm'>Back to Directory</a>