This repository has been archived on 2023-03-18. You can view files and clone it, but cannot push or open issues or pull requests.
osr-discourse-src/app/assets/javascripts/discourse/app/models/group.js
Martin Brennan 0a738bd5bc
FEATURE: Allow sending group SMTP emails with from alias (#15687)
This commit allows group SMTP emails to be sent with a
different from email address that has been set up as an
alias in the email provider. Emails from the alias will
be grouped correctly using Message-IDs in the mail client,
and replies to the alias go into the correct group inbox.
2022-02-07 13:52:01 +10:00

409 lines
11 KiB
JavaScript

import discourseComputed, { observes } from "discourse-common/utils/decorators";
import Category from "discourse/models/category";
import EmberObject from "@ember/object";
import GroupHistory from "discourse/models/group-history";
import { Promise } from "rsvp";
import RestModel from "discourse/models/rest";
import Topic from "discourse/models/topic";
import User from "discourse/models/user";
import { ajax } from "discourse/lib/ajax";
import { equal } from "@ember/object/computed";
import { isEmpty } from "@ember/utils";
const Group = RestModel.extend({
user_count: 0,
limit: null,
offset: null,
request_count: 0,
requestersLimit: null,
requestersOffset: null,
init() {
this._super(...arguments);
this.setProperties({ members: [], requesters: [] });
},
@discourseComputed("automatic_membership_email_domains")
emailDomains(value) {
return isEmpty(value) ? "" : value;
},
@discourseComputed("associated_group_ids")
associatedGroupIds(value) {
return isEmpty(value) ? [] : value;
},
@discourseComputed("automatic")
type(automatic) {
return automatic ? "automatic" : "custom";
},
async reloadMembers(params, refresh) {
if (isEmpty(this.name) || !this.can_see_members) {
return;
}
if (refresh) {
this.setProperties({ limit: null, offset: null });
}
params = Object.assign(
{ offset: (this.offset || 0) + (this.limit || 0) },
params
);
const response = await Group.loadMembers(this.name, params);
const ownerIds = new Set();
response.owners.forEach((owner) => ownerIds.add(owner.id));
const members = refresh ? [] : this.members;
members.pushObjects(
response.members.map((member) => {
member.owner = ownerIds.has(member.id);
member.primary = member.primary_group_name === this.name;
return User.create(member);
})
);
this.setProperties({
members,
user_count: response.meta.total,
limit: response.meta.limit,
offset: response.meta.offset,
});
},
findRequesters(params, refresh) {
if (isEmpty(this.name) || !this.can_see_members) {
return Promise.reject();
}
if (refresh) {
this.setProperties({ requestersOffset: null, requestersLimit: null });
}
params = Object.assign(
{
offset: (this.requestersOffset || 0) + (this.requestersLimit || 0),
requesters: true,
},
params
);
return Group.loadMembers(this.name, params).then((result) => {
const requesters = refresh ? [] : this.requesters;
requesters.pushObjects(result.members.map((m) => User.create(m)));
this.setProperties({
requesters,
request_count: result.meta.total,
requestersLimit: result.meta.limit,
requestersOffset: result.meta.offset,
});
});
},
async removeOwner(member) {
await ajax(`/admin/groups/${this.id}/owners.json`, {
type: "DELETE",
data: { user_id: member.id },
});
await this.reloadMembers({}, true);
},
async removeMember(member, params) {
await ajax(`/groups/${this.id}/members.json`, {
type: "DELETE",
data: { user_id: member.id },
});
await this.reloadMembers(params, true);
},
async leave() {
await ajax(`/groups/${this.id}/leave.json`, {
type: "DELETE",
});
await this.reloadMembers({}, true);
},
async addMembers(usernames, filter, notifyUsers, emails = []) {
const response = await ajax(`/groups/${this.id}/members.json`, {
type: "PUT",
data: { usernames, emails, notify_users: notifyUsers },
});
if (filter) {
await this._filterMembers(response.usernames);
} else {
await this.reloadMembers();
}
},
async join() {
await ajax(`/groups/${this.id}/join.json`, {
type: "PUT",
});
await this.reloadMembers({}, true);
},
async addOwners(usernames, filter, notifyUsers) {
const response = await ajax(`/admin/groups/${this.id}/owners.json`, {
type: "PUT",
data: { group: { usernames, notify_users: notifyUsers } },
});
if (filter) {
await this._filterMembers(response.usernames);
} else {
await this.reloadMembers({}, true);
}
},
_filterMembers(usernames) {
return this.reloadMembers({ filter: usernames.join(",") });
},
@discourseComputed("display_name", "name")
displayName(groupDisplayName, name) {
return groupDisplayName || name;
},
@discourseComputed("flair_bg_color")
flairBackgroundHexColor(flairBgColor) {
return flairBgColor
? flairBgColor.replace(new RegExp("[^0-9a-fA-F]", "g"), "")
: null;
},
@discourseComputed("flair_color")
flairHexColor(flairColor) {
return flairColor
? flairColor.replace(new RegExp("[^0-9a-fA-F]", "g"), "")
: null;
},
canEveryoneMention: equal("mentionable_level", 99),
@discourseComputed("visibility_level")
isPrivate(visibilityLevel) {
return visibilityLevel > 1;
},
@observes("isPrivate", "canEveryoneMention")
_updateAllowMembershipRequests() {
if (this.isPrivate || !this.canEveryoneMention) {
this.set("allow_membership_requests", false);
}
},
@discourseComputed("watching_category_ids")
watchingCategories(categoryIds) {
return Category.findByIds(categoryIds);
},
@discourseComputed("tracking_category_ids")
trackingCategories(categoryIds) {
return Category.findByIds(categoryIds);
},
@discourseComputed("watching_first_post_category_ids")
watchingFirstPostCategories(categoryIds) {
return Category.findByIds(categoryIds);
},
@discourseComputed("regular_category_ids")
regularCategories(categoryIds) {
return Category.findByIds(categoryIds);
},
@discourseComputed("muted_category_ids")
mutedCategories(categoryIds) {
return Category.findByIds(categoryIds);
},
asJSON() {
const attrs = {
name: this.name,
mentionable_level: this.mentionable_level,
messageable_level: this.messageable_level,
visibility_level: this.visibility_level,
members_visibility_level: this.members_visibility_level,
automatic_membership_email_domains: this.emailDomains,
title: this.title,
primary_group: !!this.primary_group,
grant_trust_level: this.grant_trust_level,
incoming_email: this.incoming_email,
smtp_server: this.smtp_server,
smtp_port: this.smtp_port,
smtp_ssl: this.smtp_ssl,
smtp_enabled: this.smtp_enabled,
imap_server: this.imap_server,
imap_port: this.imap_port,
imap_ssl: this.imap_ssl,
imap_mailbox_name: this.imap_mailbox_name,
imap_enabled: this.imap_enabled,
email_username: this.email_username,
email_from_alias: this.email_from_alias,
email_password: this.email_password,
flair_icon: null,
flair_upload_id: null,
flair_bg_color: this.flairBackgroundHexColor,
flair_color: this.flairHexColor,
bio_raw: this.bio_raw,
public_admission: this.public_admission,
public_exit: this.public_exit,
allow_membership_requests: this.allow_membership_requests,
full_name: this.full_name,
default_notification_level: this.default_notification_level,
membership_request_template: this.membership_request_template,
publish_read_state: this.publish_read_state,
allow_unknown_sender_topic_replies: this
.allow_unknown_sender_topic_replies,
};
["muted", "regular", "watching", "tracking", "watching_first_post"].forEach(
(s) => {
let prop =
s === "watching_first_post"
? "watchingFirstPostCategories"
: s + "Categories";
let categories = this.get(prop);
if (categories) {
attrs[s + "_category_ids"] =
categories.length > 0 ? categories.map((c) => c.get("id")) : [-1];
}
let tags = this.get(s + "_tags");
if (tags) {
attrs[s + "_tags"] = tags.length > 0 ? tags : [""];
}
}
);
let agIds = this.associated_group_ids;
if (agIds) {
attrs["associated_group_ids"] = agIds.length ? agIds : [null];
}
if (this.flair_type === "icon") {
attrs["flair_icon"] = this.flair_icon;
} else if (this.flair_type === "image") {
attrs["flair_upload_id"] = this.flair_upload_id;
}
if (!this.id) {
attrs["usernames"] = this.usernames;
attrs["owner_usernames"] = this.ownerUsernames;
}
return attrs;
},
async create() {
const response = await ajax("/admin/groups", {
type: "POST",
data: { group: this.asJSON() },
});
this.setProperties({
id: response.basic_group.id,
usernames: null,
ownerUsernames: null,
});
await this.reloadMembers();
},
save(opts = {}) {
return ajax(`/groups/${this.id}`, {
type: "PUT",
data: Object.assign({ group: this.asJSON() }, opts),
});
},
destroy() {
if (!this.id) {
return;
}
return ajax(`/admin/groups/${this.id}`, { type: "DELETE" });
},
findLogs(offset, filters) {
return ajax(`/groups/${this.name}/logs.json`, {
data: { offset, filters },
}).then((results) => {
return EmberObject.create({
logs: results["logs"].map((log) => GroupHistory.create(log)),
all_loaded: results["all_loaded"],
});
});
},
findPosts(opts) {
opts = opts || {};
const type = opts.type || "posts";
const data = {};
if (opts.beforePostId) {
data.before_post_id = opts.beforePostId;
}
if (opts.categoryId) {
data.category_id = parseInt(opts.categoryId, 10);
}
return ajax(`/groups/${this.name}/${type}.json`, { data }).then((posts) => {
return posts.map((p) => {
p.user = User.create(p.user);
p.topic = Topic.create(p.topic);
p.category = Category.findById(p.category_id);
return EmberObject.create(p);
});
});
},
setNotification(notification_level, userId) {
this.set("group_user.notification_level", notification_level);
return ajax(`/groups/${this.name}/notifications`, {
data: { notification_level, user_id: userId },
type: "POST",
});
},
requestMembership(reason) {
return ajax(`/groups/${this.name}/request_membership`, {
type: "POST",
data: { reason },
});
},
});
Group.reopenClass({
findAll(opts) {
return ajax("/groups/search.json", { data: opts }).then((groups) =>
groups.map((g) => Group.create(g))
);
},
loadMembers(name, opts) {
return ajax(`/groups/${name}/members.json`, { data: opts });
},
mentionable(name) {
return ajax(`/groups/${name}/mentionable`);
},
messageable(name) {
return ajax(`/groups/${name}/messageable`);
},
checkName(name) {
return ajax("/groups/check-name", { data: { group_name: name } });
},
});
export default Group;