Skip to content

Commit

Permalink
Merge pull request #5155 from elliefm/v311/cyr-1410-shared-subs
Browse files Browse the repository at this point in the history 
fix shared mailbox subscription bug when one user is prefix of other
  • Loading branch information
@elliefm
elliefm authored Feb 20, 2025
2 parents f4749c7 + f8b70bb commit 690b014
Show file tree
Hide file tree
Showing 9 changed files with 738 additions and 81 deletions.
247 changes: 247 additions & 0 deletions cassandane/Cassandane/Cyrus/Shared.pm
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
#!/usr/bin/perl
#
# Copyright (c) 2011-2024 Fastmail Pty Ltd. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. The name "Fastmail Pty Ltd" must not be used to
# endorse or promote products derived from this software without
# prior written permission. For permission or any legal
# details, please contact
# Fastmail Pty Ltd
# PO Box 234
# Collins St West 8007
# Victoria
# Australia
#
# 4. Redistributions of any form whatsoever must retain the following
# acknowledgment:
# "This product includes software developed by Fastmail Pty. Ltd."
#
# FASTMAIL PTY LTD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
# EVENT SHALL OPERA SOFTWARE AUSTRALIA BE LIABLE FOR ANY SPECIAL, INDIRECT
# OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
# TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
# OF THIS SOFTWARE.
#

package Cassandane::Cyrus::Shared;
use strict;
use warnings;
use DateTime;
use Data::Dumper;

use lib '.';
use base qw(Cassandane::Cyrus::TestCase);
use Cassandane::Instance;
use Cassandane::Mboxname;
use Cassandane::Util::Log;
use Cassandane::Util::Words;

$Data::Dumper::Sortkeys = 1;

sub new
{
my ($class, @args) = @_;

my $self = $class->SUPER::new({ adminstore => 1 }, @args);

return $self;
}

sub set_up
{
my ($self) = @_;

$self->SUPER::set_up();
}

sub tear_down
{
my ($self) = @_;

$self->SUPER::tear_down();
}

sub shared_subscribe_common
{
my ($self, $user1, $user2) = @_;

my $service = $self->{instance}->get_service('imap');
my $config = $self->{instance}->{config};
my $sep = $config->get_bool('unixhierarchysep', 'on') ? '/' : '.';

my $user1_inbox = Cassandane::Mboxname->new(config => $config);
$user1_inbox->from_username($user1);

my @user1_mailboxes = map {
$user1_inbox->make_child($_);
} random_words(3);
$self->{instance}->create_user($user1,
subdirs => \@user1_mailboxes);

my $user1_store = $service->create_store(username => $user1);
my $user1_talk = $user1_store->get_client();

foreach my $mb ($user1_inbox, @user1_mailboxes) {
$user1_talk->subscribe($mb->to_external('owner'));
$user1_talk->setacl($mb->to_external('owner'), $user2, 'lrs');
}

my $user2_inbox = Cassandane::Mboxname->new(config => $config);
$user2_inbox->from_username($user2);

my @user2_mailboxes = map {
$user2_inbox->make_child($_);
} random_words(3);
$self->{instance}->create_user($user2,
subdirs => \@user2_mailboxes);

my $user2_store = $service->create_store(username => $user2);
my $user2_talk = $user2_store->get_client();

foreach my $mb ($user2_inbox, @user2_mailboxes) {
$user2_talk->subscribe($mb->to_external('owner'));
$user2_talk->setacl($mb->to_external('owner'), $user1, 'lrs');
}

xlog("subscribe as $user1 to $user2\'s shared mb's");
foreach my $mb ($user2_inbox, @user2_mailboxes) {
$user1_talk->subscribe($mb->to_external('other'));
$self->assert_equals('ok', $user1_talk->get_last_completion_response());
}

xlog("make sure $user1 has the right subscriptions");
my $user1_subs = $user1_talk->list([qw(SUBSCRIBED)],
'', '*',
'RETURN', [qw(CHILDREN)]);
$self->assert_mailbox_structure($user1_subs, $sep, {
$user1_inbox->to_external('owner') => [ '\\Subscribed' ],
(map {(
$_->to_external('owner') => [ '\\Subscribed', '\\HasNoChildren' ]
)} @user1_mailboxes),
$user2_inbox->to_external('other') => [ '\\Subscribed' ],
(map {(
$_->to_external('other') => [
'\\Subscribed',
'\\HasNoChildren',
]
)} @user2_mailboxes),
});

xlog("unsub as $user1 from $user2\'s folders");
foreach my $mb ($user2_inbox, @user2_mailboxes) {
$user1_talk->unsubscribe($mb->to_external('other'));
$self->assert_equals('ok', $user1_talk->get_last_completion_response());
}

xlog("make sure $user1 has the right subscriptions");
$user1_subs = $user1_talk->list([qw(SUBSCRIBED)],
'', '*',
'RETURN', [qw(CHILDREN)]);
$self->assert_mailbox_structure($user1_subs, $sep, {
$user1_inbox->to_external('owner') => [ '\\Subscribed' ],
(map {(
$_->to_external('owner') => [ '\\Subscribed', '\\HasNoChildren' ]
)} @user1_mailboxes),
});

xlog("subscribe as $user2 to $user1\'s shared mb's");
foreach my $mb ($user1_inbox, @user1_mailboxes) {
$user2_talk->subscribe($mb->to_external('other'));
$self->assert_equals('ok',
$user2_talk->get_last_completion_response());
}

xlog("make sure $user2 has the right subscriptions");
my $user2_subs = $user2_talk->list([qw(SUBSCRIBED)],
'', '*',
'RETURN', [qw(CHILDREN)]);
$self->assert_mailbox_structure($user2_subs, $sep, {
$user2_inbox->to_external('owner') => [ '\\Subscribed' ],
(map {(
$_->to_external('owner') => [ '\\Subscribed', '\\HasNoChildren' ]
)} @user2_mailboxes),
$user1_inbox->to_external('other') => [ '\\Subscribed' ],
(map {(
$_->to_external('other') => [
'\\Subscribed',
'\\HasNoChildren',
]
)} @user1_mailboxes),
});

xlog("unsub as $user2 from $user1\'s folders");
foreach my $mb ($user1_inbox, @user1_mailboxes) {
$user2_talk->unsubscribe($mb->to_external('other'));
$self->assert_equals('ok',
$user2_talk->get_last_completion_response());
}

xlog("make sure $user2 has the right subscriptions");
$user2_subs = $user2_talk->list([qw(SUBSCRIBED)],
'', '*',
'RETURN', [qw(CHILDREN)]);
$self->assert_mailbox_structure($user2_subs, $sep, {
$user1_inbox->to_external('owner') => [ '\\Subscribed' ],
(map {(
$_->to_external('owner') => [ '\\Subscribed', '\\HasNoChildren' ]
)} @user2_mailboxes),
});
}

sub test_subscribe
{
my ($self) = @_;

$self->shared_subscribe_common('firstuser', 'seconduser');
}

sub test_subscribe_prefix
{
my ($self) = @_;

# one user is a prefix of the other!
$self->shared_subscribe_common('chris', 'christopher');
}

sub test_subscribe_vd
:VirtDomains :CrossDomains
{
my ($self) = @_;

$self->shared_subscribe_common('[email protected]',
'[email protected]');
}

sub test_subscribe_vd_prefix
:VirtDomains :CrossDomains
{
my ($self) = @_;

$self->shared_subscribe_common('[email protected]',
'[email protected]');
}

sub test_subscribe_vd_prefix2
:VirtDomains :CrossDomains
{
my ($self) = @_;

$self->shared_subscribe_common('[email protected]',
'[email protected]');
}

1;
Loading

0 comments on commit 690b014

Please sign in to comment.