mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	This is not a major speedup, but we do a couple
simple things here:
    - trim the query outside the function we
      build (that might be called multiple times)
    - don't split names before we possibly
      early-exit with an email match
		
	
		
			
				
	
	
		
			1089 lines
		
	
	
		
			30 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			1089 lines
		
	
	
		
			30 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
require("unorm");  // String.prototype.normalize polyfill for IE11
 | 
						|
const Dict = require('./dict').Dict;
 | 
						|
 | 
						|
let people_dict;
 | 
						|
let people_by_name_dict;
 | 
						|
let people_by_user_id_dict;
 | 
						|
let active_user_dict;
 | 
						|
let cross_realm_dict;
 | 
						|
let pm_recipient_count_dict;
 | 
						|
let duplicate_full_name_data;
 | 
						|
let my_user_id;
 | 
						|
 | 
						|
// We have an init() function so that our automated tests
 | 
						|
// can easily clear data.
 | 
						|
exports.init = function () {
 | 
						|
    // The following three Dicts point to the same objects
 | 
						|
    // (all people we've seen), but people_dict can have duplicate
 | 
						|
    // keys related to email changes.  We want to deprecate
 | 
						|
    // people_dict over time and always do lookups by user_id.
 | 
						|
    people_dict = new Dict({fold_case: true});
 | 
						|
    people_by_name_dict = new Dict({fold_case: true});
 | 
						|
    people_by_user_id_dict = new Dict();
 | 
						|
 | 
						|
    // The next dictionary includes all active users (human/user)
 | 
						|
    // in our realm, but it excludes non-active users and
 | 
						|
    // cross-realm bots.
 | 
						|
    active_user_dict = new Dict();
 | 
						|
    cross_realm_dict = new Dict(); // keyed by user_id
 | 
						|
    pm_recipient_count_dict = new Dict();
 | 
						|
 | 
						|
    // The next Dict maintains a set of ids of people with same full names.
 | 
						|
    duplicate_full_name_data = new Dict({fold_case: true});
 | 
						|
};
 | 
						|
 | 
						|
// WE INITIALIZE DATA STRUCTURES HERE!
 | 
						|
exports.init();
 | 
						|
 | 
						|
exports.get_person_from_user_id = function (user_id) {
 | 
						|
    if (!people_by_user_id_dict.has(user_id)) {
 | 
						|
        blueslip.error('Unknown user_id in get_person_from_user_id: ' + user_id);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    return people_by_user_id_dict.get(user_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.get_by_email = function (email) {
 | 
						|
    const person = people_dict.get(email);
 | 
						|
 | 
						|
    if (!person) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    if (person.email.toLowerCase() !== email.toLowerCase()) {
 | 
						|
        blueslip.warn(
 | 
						|
            'Obsolete email passed to get_by_email: ' + email +
 | 
						|
            ' new email = ' + person.email
 | 
						|
        );
 | 
						|
    }
 | 
						|
 | 
						|
    return person;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_realm_count = function () {
 | 
						|
    // This returns the number of active people in our realm.  It should
 | 
						|
    // exclude bots and deactivated users.
 | 
						|
    return active_user_dict.num_items();
 | 
						|
};
 | 
						|
 | 
						|
exports.id_matches_email_operand = function (user_id, email) {
 | 
						|
    const person = exports.get_by_email(email);
 | 
						|
 | 
						|
    if (!person) {
 | 
						|
        // The user may type bad data into the search bar, so
 | 
						|
        // we don't complain too loud here.
 | 
						|
        blueslip.debug('User email operand unknown: ' + email);
 | 
						|
        return false;
 | 
						|
    }
 | 
						|
 | 
						|
    return person.user_id === user_id;
 | 
						|
};
 | 
						|
 | 
						|
exports.update_email = function (user_id, new_email) {
 | 
						|
    const person = people_by_user_id_dict.get(user_id);
 | 
						|
    person.email = new_email;
 | 
						|
    people_dict.set(new_email, person);
 | 
						|
 | 
						|
    // For legacy reasons we don't delete the old email
 | 
						|
    // keys in our dictionaries, so that reverse lookups
 | 
						|
    // still work correctly.
 | 
						|
};
 | 
						|
 | 
						|
exports.get_user_id = function (email) {
 | 
						|
    const person = exports.get_by_email(email);
 | 
						|
    if (person === undefined) {
 | 
						|
        const error_msg = 'Unknown email for get_user_id: ' + email;
 | 
						|
        blueslip.error(error_msg);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    const user_id = person.user_id;
 | 
						|
    if (!user_id) {
 | 
						|
        blueslip.error('No user_id found for ' + email);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    return user_id;
 | 
						|
};
 | 
						|
 | 
						|
exports.is_known_user_id = function (user_id) {
 | 
						|
    /*
 | 
						|
    For certain low-stakes operations, such as emoji reactions,
 | 
						|
    we may get a user_id that we don't know about, because the
 | 
						|
    user may have been deactivated.  (We eventually want to track
 | 
						|
    deactivated users on the client, but until then, this is an
 | 
						|
    expedient thing we can check.)
 | 
						|
    */
 | 
						|
    return people_by_user_id_dict.has(user_id);
 | 
						|
};
 | 
						|
 | 
						|
function sort_numerically(user_ids) {
 | 
						|
    user_ids = _.map(user_ids, function (user_id) {
 | 
						|
        return parseInt(user_id, 10);
 | 
						|
    });
 | 
						|
 | 
						|
    user_ids.sort(function (a, b) {
 | 
						|
        return a - b;
 | 
						|
    });
 | 
						|
 | 
						|
    return user_ids;
 | 
						|
}
 | 
						|
 | 
						|
exports.huddle_string = function (message) {
 | 
						|
    if (message.type !== 'private') {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    let user_ids = _.map(message.display_recipient, function (recip) {
 | 
						|
        return recip.id;
 | 
						|
    });
 | 
						|
 | 
						|
    function is_huddle_recip(user_id) {
 | 
						|
        return user_id &&
 | 
						|
            people_by_user_id_dict.has(user_id) &&
 | 
						|
            !exports.is_my_user_id(user_id);
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = _.filter(user_ids, is_huddle_recip);
 | 
						|
 | 
						|
    if (user_ids.length <= 1) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.user_ids_string_to_emails_string = function (user_ids_string) {
 | 
						|
    const user_ids = user_ids_string.split(',');
 | 
						|
    let emails = _.map(user_ids, function (user_id) {
 | 
						|
        const person = people_by_user_id_dict.get(user_id);
 | 
						|
        if (person) {
 | 
						|
            return person.email;
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
    if (!_.all(emails)) {
 | 
						|
        blueslip.warn('Unknown user ids: ' + user_ids_string);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    emails = _.map(emails, function (email) {
 | 
						|
        return email.toLowerCase();
 | 
						|
    });
 | 
						|
 | 
						|
    emails.sort();
 | 
						|
 | 
						|
    return emails.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.user_ids_string_to_ids_array = function (user_ids_string) {
 | 
						|
    const user_ids = user_ids_string.split(',');
 | 
						|
    const ids = _.map(user_ids, function (id) {
 | 
						|
        return Number(id);
 | 
						|
    });
 | 
						|
    return ids;
 | 
						|
};
 | 
						|
 | 
						|
exports.emails_strings_to_user_ids_array = function (emails_string) {
 | 
						|
    const user_ids_string = exports.emails_strings_to_user_ids_string(emails_string);
 | 
						|
    if (user_ids_string === undefined) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    const user_ids_array = exports.user_ids_string_to_ids_array(user_ids_string);
 | 
						|
    return user_ids_array;
 | 
						|
};
 | 
						|
 | 
						|
exports.reply_to_to_user_ids_string = function (emails_string) {
 | 
						|
    // This is basically emails_strings_to_user_ids_string
 | 
						|
    // without blueslip warnings, since it can be called with
 | 
						|
    // invalid data.
 | 
						|
    const emails = emails_string.split(',');
 | 
						|
 | 
						|
    let user_ids = _.map(emails, function (email) {
 | 
						|
        const person = exports.get_by_email(email);
 | 
						|
        if (person) {
 | 
						|
            return person.user_id;
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
    if (!_.all(user_ids)) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.get_user_time_preferences = function (user_id) {
 | 
						|
    const user_timezone = exports.get_person_from_user_id(user_id).timezone;
 | 
						|
    if (user_timezone) {
 | 
						|
        if (page_params.twenty_four_hour_time) {
 | 
						|
            return {
 | 
						|
                timezone: user_timezone,
 | 
						|
                format: "H:mm",
 | 
						|
            };
 | 
						|
        }
 | 
						|
        return {
 | 
						|
            timezone: user_timezone,
 | 
						|
            format: "h:mm A",
 | 
						|
        };
 | 
						|
    }
 | 
						|
};
 | 
						|
 | 
						|
exports.get_user_time = function (user_id) {
 | 
						|
    const user_pref = exports.get_user_time_preferences(user_id);
 | 
						|
    if (user_pref) {
 | 
						|
        return moment().tz(user_pref.timezone).format(user_pref.format);
 | 
						|
    }
 | 
						|
};
 | 
						|
 | 
						|
exports.get_user_type = function (user_id) {
 | 
						|
    const user_profile = exports.get_person_from_user_id(user_id);
 | 
						|
 | 
						|
    if (user_profile.is_admin) {
 | 
						|
        return i18n.t("Administrator");
 | 
						|
    } else if (user_profile.is_guest) {
 | 
						|
        return i18n.t("Guest");
 | 
						|
    } else if (user_profile.is_bot) {
 | 
						|
        return i18n.t("Bot");
 | 
						|
    }
 | 
						|
    return i18n.t("Member");
 | 
						|
};
 | 
						|
 | 
						|
exports.emails_strings_to_user_ids_string = function (emails_string) {
 | 
						|
    const emails = emails_string.split(',');
 | 
						|
    return exports.email_list_to_user_ids_string(emails);
 | 
						|
};
 | 
						|
 | 
						|
exports.email_list_to_user_ids_string = function (emails) {
 | 
						|
    let user_ids = _.map(emails, function (email) {
 | 
						|
        const person = exports.get_by_email(email);
 | 
						|
        if (person) {
 | 
						|
            return person.user_id;
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
    if (!_.all(user_ids)) {
 | 
						|
        blueslip.warn('Unknown emails: ' + emails);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.safe_full_names = function (user_ids) {
 | 
						|
    let names = _.map(user_ids, function (user_id) {
 | 
						|
        const person = people_by_user_id_dict.get(user_id);
 | 
						|
        if (person) {
 | 
						|
            return person.full_name;
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
    names = _.filter(names);
 | 
						|
 | 
						|
    return names.join(', ');
 | 
						|
};
 | 
						|
 | 
						|
exports.get_full_name = function (user_id) {
 | 
						|
    return people_by_user_id_dict.get(user_id).full_name;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_recipients = function (user_ids_string) {
 | 
						|
    // See message_store.get_pm_full_names() for a similar function.
 | 
						|
 | 
						|
    const user_ids = user_ids_string.split(',');
 | 
						|
    const other_ids = _.reject(user_ids, exports.is_my_user_id);
 | 
						|
 | 
						|
    if (other_ids.length === 0) {
 | 
						|
        // private message with oneself
 | 
						|
        return exports.my_full_name();
 | 
						|
    }
 | 
						|
 | 
						|
    const names = _.map(other_ids, exports.get_full_name).sort();
 | 
						|
    return names.join(', ');
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_reply_user_string = function (message) {
 | 
						|
    const user_ids = exports.pm_with_user_ids(message);
 | 
						|
 | 
						|
    if (!user_ids) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_reply_to = function (message) {
 | 
						|
    const user_ids = exports.pm_with_user_ids(message);
 | 
						|
 | 
						|
    if (!user_ids) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    const emails = _.map(user_ids, function (user_id) {
 | 
						|
        const person = people_by_user_id_dict.get(user_id);
 | 
						|
        if (!person) {
 | 
						|
            blueslip.error('Unknown user id in message: ' + user_id);
 | 
						|
            return '?';
 | 
						|
        }
 | 
						|
        return person.email;
 | 
						|
    });
 | 
						|
 | 
						|
    emails.sort();
 | 
						|
 | 
						|
    const reply_to = emails.join(',');
 | 
						|
 | 
						|
    return reply_to;
 | 
						|
};
 | 
						|
 | 
						|
function sorted_other_user_ids(user_ids) {
 | 
						|
    // This excludes your own user id unless you're the only user
 | 
						|
    // (i.e. you sent a message to yourself).
 | 
						|
 | 
						|
    const other_user_ids = _.filter(user_ids, function (user_id) {
 | 
						|
        return !exports.is_my_user_id(user_id);
 | 
						|
    });
 | 
						|
 | 
						|
    if (other_user_ids.length >= 1) {
 | 
						|
        user_ids = other_user_ids;
 | 
						|
    } else {
 | 
						|
        user_ids = [my_user_id];
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
 | 
						|
    return user_ids;
 | 
						|
}
 | 
						|
 | 
						|
exports.pm_lookup_key = function (user_ids_string) {
 | 
						|
    /*
 | 
						|
        The server will sometimes include our own user id
 | 
						|
        in keys for PMs, but we only want our user id if
 | 
						|
        we sent a message to ourself.
 | 
						|
    */
 | 
						|
    let user_ids = user_ids_string.split(',');
 | 
						|
    user_ids = sorted_other_user_ids(user_ids);
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.all_user_ids_in_pm = function (message) {
 | 
						|
    if (message.type !== 'private') {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    if (message.display_recipient.length === 0) {
 | 
						|
        blueslip.error('Empty recipient list in message');
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    let user_ids = _.map(message.display_recipient, function (elem) {
 | 
						|
        return elem.user_id || elem.id;
 | 
						|
    });
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
    return user_ids;
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_with_user_ids = function (message) {
 | 
						|
    if (message.type !== 'private') {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    if (message.display_recipient.length === 0) {
 | 
						|
        blueslip.error('Empty recipient list in message');
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    const user_ids = _.map(message.display_recipient, function (elem) {
 | 
						|
        return elem.user_id || elem.id;
 | 
						|
    });
 | 
						|
 | 
						|
    return sorted_other_user_ids(user_ids);
 | 
						|
};
 | 
						|
 | 
						|
exports.group_pm_with_user_ids = function (message) {
 | 
						|
    if (message.type !== 'private') {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    if (message.display_recipient.length === 0) {
 | 
						|
        blueslip.error('Empty recipient list in message');
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    const user_ids = _.map(message.display_recipient, function (elem) {
 | 
						|
        return elem.user_id || elem.id;
 | 
						|
    });
 | 
						|
    const is_user_present = _.some(user_ids, function (user_id) {
 | 
						|
        return exports.is_my_user_id(user_id);
 | 
						|
    });
 | 
						|
    if (is_user_present) {
 | 
						|
        user_ids.sort();
 | 
						|
        if (user_ids.length > 2) {
 | 
						|
            return user_ids;
 | 
						|
        }
 | 
						|
    }
 | 
						|
    return false;
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_perma_link = function (message) {
 | 
						|
    const user_ids = exports.all_user_ids_in_pm(message);
 | 
						|
 | 
						|
    if (!user_ids) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    let suffix;
 | 
						|
 | 
						|
    if (user_ids.length >= 3) {
 | 
						|
        suffix = 'group';
 | 
						|
    } else {
 | 
						|
        suffix = 'pm';
 | 
						|
    }
 | 
						|
 | 
						|
    const slug = user_ids.join(',') + '-' + suffix;
 | 
						|
    const uri = "#narrow/pm-with/" + slug;
 | 
						|
    return uri;
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_with_url = function (message) {
 | 
						|
    const user_ids = exports.pm_with_user_ids(message);
 | 
						|
 | 
						|
    if (!user_ids) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    let suffix;
 | 
						|
 | 
						|
    if (user_ids.length > 1) {
 | 
						|
        suffix = 'group';
 | 
						|
    } else {
 | 
						|
        const person = exports.get_person_from_user_id(user_ids[0]);
 | 
						|
        if (person && person.email) {
 | 
						|
            suffix = person.email.split('@')[0].toLowerCase();
 | 
						|
        } else {
 | 
						|
            blueslip.error('Unknown people in message');
 | 
						|
            suffix = 'unk';
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    const slug = user_ids.join(',') + '-' + suffix;
 | 
						|
    const uri = "#narrow/pm-with/" + slug;
 | 
						|
    return uri;
 | 
						|
};
 | 
						|
 | 
						|
exports.update_email_in_reply_to = function (reply_to, user_id, new_email) {
 | 
						|
    // We try to replace an old email with a new email in a reply_to,
 | 
						|
    // but we try to avoid changing the reply_to if we don't have to,
 | 
						|
    // and we don't warn on any errors.
 | 
						|
    let emails = reply_to.split(',');
 | 
						|
 | 
						|
    const persons = _.map(emails, function (email) {
 | 
						|
        return people_dict.get(email.trim());
 | 
						|
    });
 | 
						|
 | 
						|
    if (!_.all(persons)) {
 | 
						|
        return reply_to;
 | 
						|
    }
 | 
						|
 | 
						|
    const needs_patch = _.any(persons, function (person) {
 | 
						|
        return person.user_id === user_id;
 | 
						|
    });
 | 
						|
 | 
						|
    if (!needs_patch) {
 | 
						|
        return reply_to;
 | 
						|
    }
 | 
						|
 | 
						|
    emails = _.map(persons, function (person) {
 | 
						|
        if (person.user_id === user_id) {
 | 
						|
            return new_email;
 | 
						|
        }
 | 
						|
        return person.email;
 | 
						|
    });
 | 
						|
 | 
						|
    return emails.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.pm_with_operand_ids = function (operand) {
 | 
						|
    let emails = operand.split(',');
 | 
						|
    emails = _.map(emails, function (email) { return email.trim(); });
 | 
						|
    let persons = _.map(emails, function (email) {
 | 
						|
        return people_dict.get(email);
 | 
						|
    });
 | 
						|
 | 
						|
    // If your email is included in a PM group with other people, just ignore it
 | 
						|
    if (persons.length > 1) {
 | 
						|
        persons = _.without(persons, people_by_user_id_dict.get(my_user_id));
 | 
						|
    }
 | 
						|
 | 
						|
    if (!_.all(persons)) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    let user_ids = _.map(persons, function (person) {
 | 
						|
        return person.user_id;
 | 
						|
    });
 | 
						|
 | 
						|
    user_ids = sort_numerically(user_ids);
 | 
						|
 | 
						|
    return user_ids;
 | 
						|
};
 | 
						|
 | 
						|
exports.emails_to_slug = function (emails_string) {
 | 
						|
    let slug = exports.reply_to_to_user_ids_string(emails_string);
 | 
						|
 | 
						|
    if (!slug) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    slug += '-';
 | 
						|
 | 
						|
    const emails = emails_string.split(',');
 | 
						|
 | 
						|
    if (emails.length === 1) {
 | 
						|
        slug += emails[0].split('@')[0].toLowerCase();
 | 
						|
    } else {
 | 
						|
        slug += 'group';
 | 
						|
    }
 | 
						|
 | 
						|
    return slug;
 | 
						|
};
 | 
						|
 | 
						|
exports.slug_to_emails = function (slug) {
 | 
						|
    const m = /^([\d,]+)-/.exec(slug);
 | 
						|
    if (m) {
 | 
						|
        let user_ids_string = m[1];
 | 
						|
        user_ids_string = exports.exclude_me_from_string(user_ids_string);
 | 
						|
        return exports.user_ids_string_to_emails_string(user_ids_string);
 | 
						|
    }
 | 
						|
};
 | 
						|
 | 
						|
exports.exclude_me_from_string = function (user_ids_string) {
 | 
						|
    // Exclude me from a user_ids_string UNLESS I'm the
 | 
						|
    // only one in it.
 | 
						|
    let user_ids = user_ids_string.split(',');
 | 
						|
 | 
						|
    if (user_ids.length <= 1) {
 | 
						|
        // We either have a message to ourself, an empty
 | 
						|
        // slug, or a message to somebody else where we weren't
 | 
						|
        // part of the slug.
 | 
						|
        return user_ids.join(',');
 | 
						|
    }
 | 
						|
 | 
						|
    user_ids = _.reject(user_ids, exports.is_my_user_id);
 | 
						|
 | 
						|
    return user_ids.join(',');
 | 
						|
};
 | 
						|
 | 
						|
exports.format_small_avatar_url = function (raw_url) {
 | 
						|
    const url = raw_url + "&s=50";
 | 
						|
    return url;
 | 
						|
};
 | 
						|
 | 
						|
exports.sender_is_bot = function (message) {
 | 
						|
    if (message.sender_id) {
 | 
						|
        const person = exports.get_person_from_user_id(message.sender_id);
 | 
						|
        return person.is_bot;
 | 
						|
    }
 | 
						|
    return false;
 | 
						|
};
 | 
						|
 | 
						|
exports.sender_is_guest = function (message) {
 | 
						|
    if (message.sender_id) {
 | 
						|
        const person = exports.get_person_from_user_id(message.sender_id);
 | 
						|
        return person.is_guest;
 | 
						|
    }
 | 
						|
    return false;
 | 
						|
};
 | 
						|
 | 
						|
function gravatar_url_for_email(email) {
 | 
						|
    const hash = md5(email.toLowerCase());
 | 
						|
    const avatar_url = 'https://secure.gravatar.com/avatar/' + hash + '?d=identicon';
 | 
						|
    const small_avatar_url = exports.format_small_avatar_url(avatar_url);
 | 
						|
    return small_avatar_url;
 | 
						|
}
 | 
						|
 | 
						|
exports.small_avatar_url_for_person = function (person) {
 | 
						|
    if (person.avatar_url) {
 | 
						|
        return exports.format_small_avatar_url(person.avatar_url);
 | 
						|
    }
 | 
						|
    return gravatar_url_for_email(person.email);
 | 
						|
};
 | 
						|
 | 
						|
exports.small_avatar_url = function (message) {
 | 
						|
    // Try to call this function in all places where we need 25px
 | 
						|
    // avatar images, so that the browser can help
 | 
						|
    // us avoid unnecessary network trips.  (For user-uploaded avatars,
 | 
						|
    // the s=25 parameter is essentially ignored, but it's harmless.)
 | 
						|
    //
 | 
						|
    // We actually request these at s=50, so that we look better
 | 
						|
    // on retina displays.
 | 
						|
 | 
						|
    let person;
 | 
						|
    if (message.sender_id) {
 | 
						|
        // We should always have message.sender_id, except for in the
 | 
						|
        // tutorial, where it's ok to fall back to the url in the fake
 | 
						|
        // messages.
 | 
						|
        person = exports.get_person_from_user_id(message.sender_id);
 | 
						|
    }
 | 
						|
 | 
						|
    // The first time we encounter a sender in a message, we may
 | 
						|
    // not have person.avatar_url set, but if we do, then use that.
 | 
						|
    if (person && person.avatar_url) {
 | 
						|
        return exports.small_avatar_url_for_person(person);
 | 
						|
    }
 | 
						|
 | 
						|
    // Try to get info from the message if we didn't have a `person` object
 | 
						|
    // or if the avatar was missing. We do this verbosely to avoid false
 | 
						|
    // positives on line coverage (we don't do branch checking).
 | 
						|
    if (message.avatar_url) {
 | 
						|
        return exports.format_small_avatar_url(message.avatar_url);
 | 
						|
    }
 | 
						|
 | 
						|
    // For computing the user's email, we first trust the person
 | 
						|
    // object since that is updated via our real-time sync system, but
 | 
						|
    // if unavailable, we use the sender email.
 | 
						|
    let email;
 | 
						|
    if (person) {
 | 
						|
        email = person.email;
 | 
						|
    } else {
 | 
						|
        email = message.sender_email;
 | 
						|
    }
 | 
						|
 | 
						|
    return gravatar_url_for_email(email);
 | 
						|
};
 | 
						|
 | 
						|
exports.is_valid_email_for_compose = function (email) {
 | 
						|
    if (exports.is_cross_realm_email(email)) {
 | 
						|
        return true;
 | 
						|
    }
 | 
						|
 | 
						|
    const person = exports.get_by_email(email);
 | 
						|
    if (!person) {
 | 
						|
        return false;
 | 
						|
    }
 | 
						|
    return active_user_dict.has(person.user_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.is_valid_bulk_emails_for_compose = function (emails) {
 | 
						|
    // Returns false if at least one of the emails is invalid.
 | 
						|
    return _.every(emails, function (email) {
 | 
						|
        if (!exports.is_valid_email_for_compose(email)) {
 | 
						|
            return false;
 | 
						|
        }
 | 
						|
        return true;
 | 
						|
    });
 | 
						|
};
 | 
						|
 | 
						|
exports.get_active_user_for_email = function (email) {
 | 
						|
    const person = exports.get_by_email(email);
 | 
						|
    if (!person) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    return active_user_dict.get(person.user_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.is_active_user_for_popover = function (user_id) {
 | 
						|
    // For popover menus, we include cross-realm bots as active
 | 
						|
    // users.
 | 
						|
 | 
						|
    if (cross_realm_dict.get(user_id)) {
 | 
						|
        return true;
 | 
						|
    }
 | 
						|
    if (active_user_dict.has(user_id)) {
 | 
						|
        return true;
 | 
						|
    }
 | 
						|
 | 
						|
    // TODO: We can report errors here once we start loading
 | 
						|
    //       deactivated users at page-load time. For now just warn.
 | 
						|
    if (!people_by_user_id_dict.has(user_id)) {
 | 
						|
        blueslip.warn("Unexpectedly invalid user_id in user popover query: " + user_id);
 | 
						|
    }
 | 
						|
 | 
						|
    return false;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_all_persons = function () {
 | 
						|
    return people_by_user_id_dict.values();
 | 
						|
};
 | 
						|
 | 
						|
exports.get_realm_persons = function () {
 | 
						|
    return active_user_dict.values();
 | 
						|
};
 | 
						|
 | 
						|
exports.get_active_human_persons = function () {
 | 
						|
    const human_persons = exports.get_realm_persons().filter(function (person)  {
 | 
						|
        return !person.is_bot;
 | 
						|
    });
 | 
						|
    return human_persons;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_active_user_ids = function () {
 | 
						|
    // This includes active users and active bots.
 | 
						|
    return active_user_dict.keys();
 | 
						|
};
 | 
						|
 | 
						|
exports.is_cross_realm_email = function (email) {
 | 
						|
    const person = exports.get_by_email(email);
 | 
						|
    if (!person) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    return cross_realm_dict.has(person.user_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.get_recipient_count = function (person) {
 | 
						|
    // We can have fake person objects like the "all"
 | 
						|
    // pseudo-person in at-mentions.  They will have
 | 
						|
    // the pm_recipient_count on the object itself.
 | 
						|
    if (person.pm_recipient_count) {
 | 
						|
        return person.pm_recipient_count;
 | 
						|
    }
 | 
						|
 | 
						|
    const user_id = person.user_id || person.id;
 | 
						|
    const count = pm_recipient_count_dict.get(user_id);
 | 
						|
 | 
						|
    return count || 0;
 | 
						|
};
 | 
						|
 | 
						|
exports.incr_recipient_count = function (user_id) {
 | 
						|
    const old_count = pm_recipient_count_dict.get(user_id) || 0;
 | 
						|
    pm_recipient_count_dict.set(user_id, old_count + 1);
 | 
						|
};
 | 
						|
 | 
						|
const unicode_marks = /\p{M}/gu;
 | 
						|
 | 
						|
exports.remove_diacritics = function (s) {
 | 
						|
    return s.normalize("NFKD").replace(unicode_marks, "");
 | 
						|
};
 | 
						|
 | 
						|
exports.person_matches_query = function (user, query) {
 | 
						|
    return exports.build_person_matcher(query)(user);
 | 
						|
};
 | 
						|
 | 
						|
exports.build_person_matcher = function (query) {
 | 
						|
    query = query.trim();
 | 
						|
 | 
						|
    let termlets = query.toLowerCase().split(/\s+/);
 | 
						|
    termlets = _.map(termlets, function (termlet) {
 | 
						|
        return termlet.trim();
 | 
						|
    });
 | 
						|
 | 
						|
    return function (user) {
 | 
						|
        const email = user.email.toLowerCase();
 | 
						|
 | 
						|
        if (email.indexOf(query) === 0) {
 | 
						|
            return true;
 | 
						|
        }
 | 
						|
 | 
						|
        const names = user.full_name.toLowerCase().split(' ');
 | 
						|
        return _.all(termlets, function (termlet) {
 | 
						|
            const is_ascii = /^[a-z]+$/.test(termlet);
 | 
						|
            return _.any(names, function (name) {
 | 
						|
                if (is_ascii) {
 | 
						|
                    // Only ignore diacritics if the query is plain ascii
 | 
						|
                    name = exports.remove_diacritics(name);
 | 
						|
                }
 | 
						|
                if (name.indexOf(termlet) === 0) {
 | 
						|
                    return true;
 | 
						|
                }
 | 
						|
            });
 | 
						|
        });
 | 
						|
    };
 | 
						|
};
 | 
						|
 | 
						|
exports.filter_people_by_search_terms = function (users, search_terms) {
 | 
						|
    const filtered_users = new Dict();
 | 
						|
 | 
						|
    // Build our matchers outside the loop to avoid some
 | 
						|
    // search overhead that is not user-specific.
 | 
						|
    const matchers = _.map(search_terms, function (search_term) {
 | 
						|
        return exports.build_person_matcher(search_term);
 | 
						|
    });
 | 
						|
 | 
						|
    // Loop through users and populate filtered_users only
 | 
						|
    // if they include search_terms
 | 
						|
    _.each(users, function (user) {
 | 
						|
        const person = exports.get_by_email(user.email);
 | 
						|
        // Get person object (and ignore errors)
 | 
						|
        if (!person || !person.full_name) {
 | 
						|
            return;
 | 
						|
        }
 | 
						|
 | 
						|
        // Return user emails that include search terms
 | 
						|
        const match = _.any(matchers, function (matcher) {
 | 
						|
            return matcher(user);
 | 
						|
        });
 | 
						|
 | 
						|
        if (match) {
 | 
						|
            filtered_users.set(person.user_id, true);
 | 
						|
        }
 | 
						|
    });
 | 
						|
    return filtered_users;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_by_name = function (name) {
 | 
						|
    return people_by_name_dict.get(name);
 | 
						|
};
 | 
						|
 | 
						|
function people_cmp(person1, person2) {
 | 
						|
    const name_cmp = util.strcmp(person1.full_name, person2.full_name);
 | 
						|
    if (name_cmp < 0) {
 | 
						|
        return -1;
 | 
						|
    } else if (name_cmp > 0) {
 | 
						|
        return 1;
 | 
						|
    }
 | 
						|
    return util.strcmp(person1.email, person2.email);
 | 
						|
}
 | 
						|
 | 
						|
exports.get_rest_of_realm = function get_rest_of_realm() {
 | 
						|
    const people_minus_you = [];
 | 
						|
    active_user_dict.each(function (person) {
 | 
						|
        if (!exports.is_current_user(person.email)) {
 | 
						|
            people_minus_you.push({email: person.email,
 | 
						|
                                   user_id: person.user_id,
 | 
						|
                                   full_name: person.full_name});
 | 
						|
        }
 | 
						|
    });
 | 
						|
    return people_minus_you.sort(people_cmp);
 | 
						|
};
 | 
						|
 | 
						|
exports.track_duplicate_full_name = function (full_name, user_id, to_remove) {
 | 
						|
    let ids = new Dict();
 | 
						|
    if (duplicate_full_name_data.has(full_name)) {
 | 
						|
        ids = duplicate_full_name_data.get(full_name);
 | 
						|
    }
 | 
						|
    if (!to_remove && user_id) {
 | 
						|
        ids.set(user_id);
 | 
						|
    }
 | 
						|
    if (to_remove && user_id && ids.has(user_id)) {
 | 
						|
        ids.del(user_id);
 | 
						|
    }
 | 
						|
    duplicate_full_name_data.set(full_name, ids);
 | 
						|
};
 | 
						|
 | 
						|
exports.is_duplicate_full_name = function (full_name) {
 | 
						|
    if (duplicate_full_name_data.has(full_name)) {
 | 
						|
        return duplicate_full_name_data.get(full_name).keys().length > 1;
 | 
						|
    }
 | 
						|
    return false;
 | 
						|
};
 | 
						|
 | 
						|
exports.get_mention_syntax = function (full_name, user_id, silent) {
 | 
						|
    let mention = '';
 | 
						|
    if (silent) {
 | 
						|
        mention += '@_**';
 | 
						|
    } else {
 | 
						|
        mention += '@**';
 | 
						|
    }
 | 
						|
    mention += full_name;
 | 
						|
    if (!user_id) {
 | 
						|
        blueslip.warn('get_mention_syntax called without user_id.');
 | 
						|
    }
 | 
						|
    if (exports.is_duplicate_full_name(full_name) && user_id) {
 | 
						|
        mention += '|' + user_id;
 | 
						|
    }
 | 
						|
    mention += '**';
 | 
						|
    return mention;
 | 
						|
};
 | 
						|
 | 
						|
exports.add = function add(person) {
 | 
						|
    if (person.user_id) {
 | 
						|
        people_by_user_id_dict.set(person.user_id, person);
 | 
						|
    } else {
 | 
						|
        // We eventually want to lock this down completely
 | 
						|
        // and report an error and not update other the data
 | 
						|
        // structures here, but we have a lot of edge cases
 | 
						|
        // with cross-realm bots, zephyr users, etc., deactivated
 | 
						|
        // users, where we are probably fine for now not to
 | 
						|
        // find them via user_id lookups.
 | 
						|
        blueslip.warn('No user_id provided for ' + person.email);
 | 
						|
    }
 | 
						|
 | 
						|
    exports.track_duplicate_full_name(person.full_name, person.user_id);
 | 
						|
    people_dict.set(person.email, person);
 | 
						|
    people_by_name_dict.set(person.full_name, person);
 | 
						|
};
 | 
						|
 | 
						|
exports.add_in_realm = function (person) {
 | 
						|
    active_user_dict.set(person.user_id, person);
 | 
						|
    exports.add(person);
 | 
						|
};
 | 
						|
 | 
						|
exports.deactivate = function (person) {
 | 
						|
    // We don't fully remove a person from all of our data
 | 
						|
    // structures, because deactivated users can be part
 | 
						|
    // of somebody's PM list.
 | 
						|
    active_user_dict.del(person.user_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.report_late_add = function (user_id, email) {
 | 
						|
    // This function is extracted to make unit testing easier,
 | 
						|
    // plus we may fine-tune our reporting here for different
 | 
						|
    // types of realms.
 | 
						|
    const msg = 'Added user late: user_id=' + user_id + ' email=' + email;
 | 
						|
 | 
						|
    if (reload_state.is_in_progress()) {
 | 
						|
        blueslip.log(msg);
 | 
						|
    } else {
 | 
						|
        blueslip.error(msg);
 | 
						|
    }
 | 
						|
};
 | 
						|
 | 
						|
exports.extract_people_from_message = function (message) {
 | 
						|
    let involved_people;
 | 
						|
 | 
						|
    switch (message.type) {
 | 
						|
    case 'stream':
 | 
						|
        involved_people = [{full_name: message.sender_full_name,
 | 
						|
                            user_id: message.sender_id,
 | 
						|
                            email: message.sender_email}];
 | 
						|
        break;
 | 
						|
 | 
						|
    case 'private':
 | 
						|
        involved_people = message.display_recipient;
 | 
						|
        break;
 | 
						|
    }
 | 
						|
 | 
						|
    // Add new people involved in this message to the people list
 | 
						|
    _.each(involved_people, function (person) {
 | 
						|
        if (person.unknown_local_echo_user) {
 | 
						|
            return;
 | 
						|
        }
 | 
						|
 | 
						|
        const user_id = person.user_id || person.id;
 | 
						|
 | 
						|
        if (people_by_user_id_dict.has(user_id)) {
 | 
						|
            return;
 | 
						|
        }
 | 
						|
 | 
						|
        exports.report_late_add(user_id, person.email);
 | 
						|
 | 
						|
        exports.add({
 | 
						|
            email: person.email,
 | 
						|
            user_id: user_id,
 | 
						|
            full_name: person.full_name,
 | 
						|
            is_admin: person.is_realm_admin || false,
 | 
						|
            is_bot: person.is_bot || false,
 | 
						|
        });
 | 
						|
    });
 | 
						|
};
 | 
						|
 | 
						|
exports.maybe_incr_recipient_count = function (message) {
 | 
						|
    if (message.type !== 'private') {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    if (!message.sent_by_me) {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    // Track the number of PMs we've sent to this person to improve autocomplete
 | 
						|
    _.each(message.display_recipient, function (person) {
 | 
						|
 | 
						|
        if (person.unknown_local_echo_user) {
 | 
						|
            return;
 | 
						|
        }
 | 
						|
 | 
						|
        const user_id = person.user_id || person.id;
 | 
						|
        exports.incr_recipient_count(user_id);
 | 
						|
    });
 | 
						|
};
 | 
						|
 | 
						|
exports.set_full_name = function (person_obj, new_full_name) {
 | 
						|
    if (people_by_name_dict.has(person_obj.full_name)) {
 | 
						|
        people_by_name_dict.del(person_obj.full_name);
 | 
						|
    }
 | 
						|
    // Remove previous and add new full name to the duplicate full name tracker.
 | 
						|
    exports.track_duplicate_full_name(person_obj.full_name, person_obj.user_id, true);
 | 
						|
    exports.track_duplicate_full_name(new_full_name, person_obj.user_id);
 | 
						|
    people_by_name_dict.set(new_full_name, person_obj);
 | 
						|
    person_obj.full_name = new_full_name;
 | 
						|
};
 | 
						|
 | 
						|
exports.set_custom_profile_field_data = function (user_id, field) {
 | 
						|
    if (field.id === undefined) {
 | 
						|
        blueslip.error("Unknown field id " + field.id);
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    people_by_user_id_dict.get(user_id).profile_data[field.id] = {
 | 
						|
        value: field.value,
 | 
						|
        rendered_value: field.rendered_value,
 | 
						|
    };
 | 
						|
};
 | 
						|
 | 
						|
exports.is_current_user = function (email) {
 | 
						|
    if (email === null || email === undefined) {
 | 
						|
        return false;
 | 
						|
    }
 | 
						|
 | 
						|
    return email.toLowerCase() === exports.my_current_email().toLowerCase();
 | 
						|
};
 | 
						|
 | 
						|
exports.initialize_current_user = function (user_id) {
 | 
						|
    my_user_id = user_id;
 | 
						|
};
 | 
						|
 | 
						|
exports.my_full_name = function () {
 | 
						|
    return people_by_user_id_dict.get(my_user_id).full_name;
 | 
						|
};
 | 
						|
 | 
						|
exports.my_current_email = function () {
 | 
						|
    return people_by_user_id_dict.get(my_user_id).email;
 | 
						|
};
 | 
						|
 | 
						|
exports.my_current_user_id = function () {
 | 
						|
    return my_user_id;
 | 
						|
};
 | 
						|
 | 
						|
exports.my_custom_profile_data = function (field_id) {
 | 
						|
    if (field_id === undefined) {
 | 
						|
        blueslip.error("Undefined field id");
 | 
						|
        return;
 | 
						|
    }
 | 
						|
    return exports.get_custom_profile_data(my_user_id, field_id);
 | 
						|
};
 | 
						|
 | 
						|
exports.get_custom_profile_data = function (user_id, field_id) {
 | 
						|
    const profile_data = people_by_user_id_dict.get(user_id).profile_data;
 | 
						|
    if (profile_data === undefined) {
 | 
						|
        return null;
 | 
						|
    }
 | 
						|
    return profile_data[field_id];
 | 
						|
};
 | 
						|
 | 
						|
exports.is_my_user_id = function (user_id) {
 | 
						|
    if (!user_id) {
 | 
						|
        return false;
 | 
						|
    }
 | 
						|
    return user_id.toString() === my_user_id.toString();
 | 
						|
};
 | 
						|
 | 
						|
exports.initialize = function () {
 | 
						|
    _.each(page_params.realm_users, function (person) {
 | 
						|
        exports.add_in_realm(person);
 | 
						|
    });
 | 
						|
 | 
						|
    _.each(page_params.realm_non_active_users, function (person) {
 | 
						|
        exports.add(person);
 | 
						|
    });
 | 
						|
 | 
						|
    _.each(page_params.cross_realm_bots, function (person) {
 | 
						|
        if (!people_dict.has(person.email)) {
 | 
						|
            exports.add(person);
 | 
						|
        }
 | 
						|
        cross_realm_dict.set(person.user_id, person);
 | 
						|
    });
 | 
						|
 | 
						|
    exports.initialize_current_user(page_params.user_id);
 | 
						|
 | 
						|
    delete page_params.realm_users; // We are the only consumer of this.
 | 
						|
    delete page_params.realm_non_active_users;
 | 
						|
    delete page_params.cross_realm_bots;
 | 
						|
};
 | 
						|
 | 
						|
window.people = exports;
 |