@rnaga/wp-node 1.1.0

package/core/utils/user-self-registration.util.js

@@ -0,0 +1,171 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserSelfRegistrationUtil = void 0;
+const config_1 = require("../../config");
+const constants_1 = require("../../constants");
+const component_1 = require("../../decorators/component");
+const options_trx_1 = require("../../transactions/options.trx");
+const signup_trx_1 = require("../../transactions/signup.trx");
+const user_trx_1 = require("../../transactions/user.trx");
+const components_1 = require("../components");
+const logger_1 = require("../logger");
+const options_1 = require("../options");
+const vars_1 = require("../vars");
+const query_util_1 = require("./query.util");
+const signup_util_1 = require("./signup.util");
+const user_util_1 = require("./user.util");
+let UserSelfRegistrationUtil = class UserSelfRegistrationUtil {
+    config;
+    components;
+    signupUtil;
+    signupTrx;
+    options;
+    optionsTrx;
+    userTrx;
+    userUtil;
+    vars;
+    logger;
+    constructor(config, components, signupUtil, signupTrx, options, optionsTrx, userTrx, userUtil, vars, logger) {
+        this.config = config;
+        this.components = components;
+        this.signupUtil = signupUtil;
+        this.signupTrx = signupTrx;
+        this.options = options;
+        this.optionsTrx = optionsTrx;
+        this.userTrx = userTrx;
+        this.userUtil = userUtil;
+        this.vars = vars;
+        this.logger = logger;
+    }
+    async canSignup() {
+        if (this.config.isMultiSite()) {
+            // If the site is multisite, check if the registration type is 'all' or 'user' in signup table
+            return await this.signupUtil.canUserSignup();
+        }
+        // For single site, check 'users_can_register' option in options table
+        // See get_option( 'users_can_register' ) in wp-login.php
+        return (parseInt((await this.options.get("users_can_register")) ?? "0") === 1);
+    }
+    async changeEligibility(enable) {
+        if (this.config.isMultiSite()) {
+            // If the site is multisite, update the registration type in signup table
+            return await this.signupTrx.changeUserSignupEligibility(enable);
+        }
+        // For single site, update 'users_can_register' option in options table
+        return await this.optionsTrx.update("users_can_register", enable ? 1 : 0);
+    }
+    /**
+     * Register a new user
+     *
+     * Multisite: create a new record in the signup table along with activation key
+     * Single site: create a new user in the users table along with activation key
+     *
+     * After this gets called, "activate" should be called to validate activation key and activate the user.
+     *
+     * @param userLogin - Username
+     * @param email - Email
+     * @returns number - New user ID
+     */
+    async registerNew(userLogin, email) {
+        if (!(await this.canSignup())) {
+            throw new Error("User registration is not allowed.");
+        }
+        let id;
+        // Multi-site
+        if (this.config.isMultiSite()) {
+            const [success, error] = await this.signupUtil.validateUser(userLogin, email);
+            if (!success) {
+                throw new Error(error);
+            }
+            id = await this.signupTrx.insert({
+                type: "user",
+                user: userLogin,
+                user_email: email,
+            });
+        }
+        else {
+            // Single site
+            id = await this.userTrx.registerNew(userLogin, email);
+        }
+        if (!id) {
+            throw new Error("Could not create user");
+        }
+        const activationKey = await this.getActivationKey(userLogin, email);
+        if (!activationKey) {
+            throw new Error("Could not create activation key");
+        }
+        const context = this.vars.CONTEXT;
+        context.hooks.action.do("core_register_new_user", activationKey, userLogin, email, context);
+        return {
+            id,
+            userLogin,
+            email,
+            activationKey,
+        };
+    }
+    // This works only after registerNew is called
+    async getActivationKey(userLogin, email) {
+        const queryUtil = this.components.get(query_util_1.QueryUtil);
+        if (this.config.isMultiSite()) {
+            const signups = await queryUtil.common("signups", (query) => {
+                query
+                    .where("user_login", userLogin)
+                    .where("user_email", email)
+                    .builder.limit(1);
+            });
+            return signups?.[0].activation_key;
+        }
+        return await this.userUtil.getPasswordResetKey(userLogin);
+    }
+    async activate(activationKey, userRef) {
+        let userId = 0;
+        let success = false;
+        if (this.config.isMultiSite()) {
+            const result = await this.signupTrx.activate(activationKey, {
+                userRef,
+            });
+            userId = result.user_id;
+            success = result.user_id > 0;
+        }
+        else {
+            const userIdOrFalse = await this.userUtil.checkPasswordResetKey(activationKey, userRef);
+            success = false !== userIdOrFalse && userIdOrFalse > 0;
+            if (success) {
+                userId = userIdOrFalse;
+            }
+        }
+        if (!success) {
+            this.logger.error("Could not activate user", { userRef });
+            return [false, "Could not activate user"];
+        }
+        // Attach default role
+        const defaultRole = await this.options.get("default_role");
+        await this.userTrx.upsertRole(userId, defaultRole);
+        // Account activated. Generate reset key for user to set password
+        const resetKey = await this.userUtil.getPasswordResetKey(userRef);
+        return [true, resetKey];
+    }
+};
+exports.UserSelfRegistrationUtil = UserSelfRegistrationUtil;
+exports.UserSelfRegistrationUtil = UserSelfRegistrationUtil = __decorate([
+    (0, component_1.component)({ scope: constants_1.Scope.Transient }),
+    __metadata("design:paramtypes", [config_1.Config,
+        components_1.Components,
+        signup_util_1.SignupUtil,
+        signup_trx_1.SignupTrx,
+        options_1.Options,
+        options_trx_1.OptionsTrx,
+        user_trx_1.UserTrx,
+        user_util_1.UserUtil,
+        vars_1.Vars,
+        logger_1.Logger])
+], UserSelfRegistrationUtil);

package/core/utils/user.util.d.ts

@@ -0,0 +1,153 @@
+import { Config } from "../../config";
+import * as types from "../../types";
+import { Components } from "../components";
+import { Logger } from "../logger";
+import { User } from "../user";
+import { Vars } from "../vars";
+type DataGetBlogs = {
+    blog_id: number;
+    domain: string;
+    path: string;
+    site_id: number;
+    siteurl: string | undefined;
+    archived: number;
+    spam: number;
+    deleted: number;
+    rolenames: string[] | undefined;
+    blog_roles: Record<string, types.Role>;
+    blogname: string | undefined;
+};
+export declare class UserUtil {
+    private config;
+    private logger;
+    private components;
+    private vars;
+    constructor(config: Config, logger: Logger, components: Components, vars: Vars);
+    get(userRef: string | number): Promise<User>;
+    toUsers(users: types.Tables["users"][]): Promise<User[]>;
+    countPosts(userIds: number[], postType?: types.PostType, options?: Partial<{
+        publicOnly: boolean;
+    }>): Promise<[{
+        post_author: number;
+        count: number;
+    }] | undefined>;
+    resetPassword(user: User, newPassword: string): Promise<void>;
+    isPasswordResetAllowed(user: User): boolean;
+    checkPasswordResetKey(resetKey: string, userRef: string | number): Promise<number | false>;
+    getPasswordResetKey(userLogin: string, options?: Partial<{
+        registration: boolean;
+    }>): Promise<string>;
+    private roleNamesToCapabilities;
+    getSites(userRef: string | number): Promise<{
+        user: types.WpUsers;
+        primary_blog: {
+            blog_id: number;
+            site_id: number;
+            blog_roles: Record<string, {
+                name: string;
+                capabilities: string[];
+            }>;
+            blogname: string;
+            rolenames: string[];
+            capabilities: string[];
+            sitename: string;
+            siteurl: string;
+        } | undefined;
+        is_multisite: boolean;
+        sites: {
+            site_id: number;
+            sitename: string;
+            siteurl: string;
+            is_superadmin: boolean;
+            blogs: (DataGetBlogs & {
+                capabilities: string[];
+                blog_roles: Record<string, types.Role>;
+                blogname: string | undefined;
+            })[];
+        }[];
+    } | {
+        user: types.WpUsers;
+        primary_blog: {
+            capabilities: string[];
+            blog_id: number;
+            domain: string;
+            path: string;
+            site_id: number;
+            siteurl: string | undefined;
+            archived: number;
+            spam: number;
+            deleted: number;
+            rolenames: string[] | undefined;
+            blog_roles: Record<string, types.Role>;
+            blogname: string | undefined;
+        };
+        is_multisite: boolean;
+        sites: undefined;
+    }>;
+    getSingleSite(userRef: string | number): Promise<{
+        user: types.WpUsers;
+        primary_blog: {
+            capabilities: string[];
+            blog_id: number;
+            domain: string;
+            path: string;
+            site_id: number;
+            siteurl: string | undefined;
+            archived: number;
+            spam: number;
+            deleted: number;
+            rolenames: string[] | undefined;
+            blog_roles: Record<string, types.Role>;
+            blogname: string | undefined;
+        };
+        is_multisite: boolean;
+        sites: undefined;
+    }>;
+    getMultiSites(userRef: string | number): Promise<{
+        user: types.WpUsers;
+        primary_blog: {
+            blog_id: number;
+            site_id: number;
+            blog_roles: Record<string, {
+                name: string;
+                capabilities: string[];
+            }>;
+            blogname: string;
+            rolenames: string[];
+            capabilities: string[];
+            sitename: string;
+            siteurl: string;
+        } | undefined;
+        is_multisite: boolean;
+        sites: {
+            site_id: number;
+            sitename: string;
+            siteurl: string;
+            is_superadmin: boolean;
+            blogs: (DataGetBlogs & {
+                capabilities: string[];
+                blog_roles: Record<string, types.Role>;
+                blogname: string | undefined;
+            })[];
+        }[];
+    }>;
+    getPrimaryBlogId(userRef: string | number): Promise<any>;
+    getRoleNames(userRefOrUser: string | number | User): Promise<Map<number, string[]>>;
+    getSiteIds(userRef: string | number): Promise<number[]>;
+    getBlogIds(userRef: string | number): Promise<number[]>;
+    getBlogs(userRef: string | number, options?: Partial<{
+        siteId: number;
+        blogId: number;
+    }>): Promise<DataGetBlogs[]>;
+    checkSuperAdminStatus(userRefOrUser: string | number | User, args?: {
+        siteIds?: number[];
+        blogIds?: number[];
+    }): Promise<[boolean, number[]]>;
+    hasCapabilities(userRefOrUser: number | string | User, targetCapabilities: string[], options?: {
+        blogIds?: number[];
+    }): Promise<boolean>;
+    getUniqueNicename(nicename: string, userLogin: string, maxSuffix?: number): Promise<string>;
+    getUniqueUserLogin(maxSuffix?: number): Promise<string>;
+}
+export {};
+//# sourceMappingURL=user.util.d.ts.map

package/core/utils/user.util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.util.d.ts","sourceRoot":"","sources":["../../../src/core/utils/user.util.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAGtC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAK/B,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,qBACa,QAAQ;IAEjB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,IAAI;gBAHJ,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,IAAI;IAGd,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAI5B,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IAStC,UAAU,CACd,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,GAAE,KAAK,CAAC,QAAiB,EACjC,OAAO,CAAC,EAAE,OAAO,CAAC;QAChB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;qBAa2C,MAAM;eAAS,MAAM;;IAI9D,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM;IAiBnD,sBAAsB,CAAC,IAAI,EAAE,IAAI;IAU3B,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAmDhE,mBAAmB,CACvB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,OAAO,CAAC;QAChB,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;IA6CJ,OAAO,CAAC,uBAAuB;IAUzB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;sBA6DR,MAAM;qBAAW,MAAM;;;;;;;;;8BAbpC,MAAM,EAAE;4BACV,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;0BAC5B,MAAM,GAAG,SAAS;;;;;;;qBApPvB,MAAM;oBACP,MAAM;kBACR,MAAM;qBACH,MAAM;qBACN,MAAM,GAAG,SAAS;sBACjB,MAAM;kBACV,MAAM;qBACH,MAAM;uBACJ,MAAM,EAAE,GAAG,SAAS;wBACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;sBAC5B,MAAM,GAAG,SAAS;;;;;IA+LtB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;;;;qBAzMnC,MAAM;oBACP,MAAM;kBACR,MAAM;qBACH,MAAM;qBACN,MAAM,GAAG,SAAS;sBACjB,MAAM;kBACV,MAAM;qBACH,MAAM;uBACJ,MAAM,EAAE,GAAG,SAAS;wBACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;sBAC5B,MAAM,GAAG,SAAS;;;;;IA0NtB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;;;;;;;;;;;;sBA2Bb,MAAM;qBAAW,MAAM;;;;;;;;;8BAbpC,MAAM,EAAE;4BACV,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;0BAC5B,MAAM,GAAG,SAAS;;;;IAmF1B,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAezC,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IA0ElD,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAwBnC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAoBnC,QAAQ,CACZ,OAAO,EAAE,MAAM,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,GACD,OAAO,CAAC,YAAY,EAAE,CAAC;IA2EpB,qBAAqB,CACzB,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EACrC,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,GACA,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAsDzB,eAAe,CACnB,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EACrC,kBAAkB,EAAE,MAAM,EAAE,EAC5B,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB;IA+CG,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,SAAS,GAAE,MAAW;IA4BlB,kBAAkB,CAAC,SAAS,GAAE,MAAW;CA+BhD"}