File: Search.php

package info (click to toggle)
roundcube 1.6.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 44,868 kB
  • sloc: javascript: 195,588; php: 76,818; sql: 3,150; sh: 2,882; pascal: 1,079; makefile: 234; xml: 93; perl: 73; ansic: 48; python: 21
file content (191 lines) | stat: -rw-r--r-- 8,130 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<?php

namespace Roundcube\Tests\Actions\Mail;

use PHPUnit\Framework\Attributes\DataProvider;
use Roundcube\Tests\ActionTestCase;
use Roundcube\Tests\OutputJsonMock;

/**
 * Test class to test rcmail_action_mail_search
 */
class Actions_Mail_Search extends ActionTestCase
{
    /**
     * Test searching mail (empty result)
     */
    function test_search_empty_result()
    {
        $action = new \rcmail_action_mail_search();
        $output = $this->initOutput(\rcmail_action::MODE_AJAX, 'mail', 'search');

        $this->assertTrue($action->checks());

        $_GET = [
            '_q'    => 'test',
            '_mbox' => 'INBOX',
        ];

        // Set expected storage function calls/results
        self::initStorage();
        \rcmail::get_instance()->storage
            ->registerFunction('set_page')
            ->registerFunction('set_search_set')
            ->registerFunction('search', new \rcube_result_index())
            ->registerFunction('get_search_set', [])
            ->registerFunction('get_search_set', [])
            ->registerFunction('get_pagesize', 10)
            ->registerFunction('get_pagesize', 10)
            ->registerFunction('get_folder', 'INBOX')
            ->registerFunction('list_messages', [])
            ->registerFunction('get_error_code', null)
            ->registerFunction('count', 0)
            ->registerFunction('get_quota', false);

        $this->runAndAssert($action, OutputJsonMock::E_EXIT);

        $result = $output->getOutput();

        $this->assertSame(['Content-Type: application/json; charset=UTF-8'], $output->headers);
        $this->assertSame('search', $result['action']);
        $this->assertSame(0, $result['env']['messagecount']);
        $this->assertSame(0, $result['env']['pagecount']);
        $this->assertSame(0, $result['env']['exists']);
        $this->assertTrue(strpos($result['exec'], 'this.display_message("Search returned no matches.","notice",0);') !== false);
        $this->assertTrue(strpos($result['exec'], 'this.set_rowcount("Mailbox is empty","INBOX");') !== false);
        $this->assertTrue(strpos($result['exec'], 'this.set_pagetitle("Roundcube Webmail :: Search result");') !== false);
        $this->assertTrue(strpos($result['exec'], 'this.set_quota') !== false);
    }

    /**
     * Test searching mail (non-empty result)
     */
    function test_search_non_empty_result()
    {
        $action = new \rcmail_action_mail_search();
        $output = $this->initOutput(\rcmail_action::MODE_AJAX, 'mail', 'search');

        $_GET = [
            '_q'    => 'test',
            '_mbox' => 'INBOX',
        ];

        $index = new \rcube_result_index('INBOX', 'SEARCH 10');

        // Set expected storage function calls/results
        self::initStorage()
            ->registerFunction('set_page')
            ->registerFunction('set_search_set')
            ->registerFunction('search',)
            ->registerFunction('get_search_set', ['SEARCH HEADER SUBJECT test', $index, 'UTF-8', '', false])
            ->registerFunction('get_search_set', ['SEARCH HEADER SUBJECT test', $index, 'UTF-8', '', false])
            ->registerFunction('get_pagesize', 10)
            ->registerFunction('get_pagesize', 10)
            ->registerFunction('get_folder', 'INBOX')
            ->registerFunction('list_messages', [
                10 => \rcube_message_header::from_array([
                    'id' => 42,
                    'uid' => 10,
                    'subject' => 'test message',
                    'from' => 'test1@test.com',
                    'to' => 'Test <test2@test.com>',
                    'date' => 'Sun, 13 Mar 2022 17:08:18 +0100',
                    'size' => 889,
                    'content-type' => 'text/plain',
                ])
            ])
            ->registerFunction('get_threading', false)
            ->registerFunction('get_threading', false)
            ->registerFunction('get_threading', false)
            ->registerFunction('count', 1)
            ->registerFunction('count', 1)
            ->registerFunction('count', 1)
            ->registerFunction('folder_data', [])
            ->registerFunction('get_quota', false);

        $this->runAndAssert($action, OutputJsonMock::E_EXIT);

        $result = $output->getOutput();

        $this->assertSame(['Content-Type: application/json; charset=UTF-8'], $output->headers);
        $this->assertSame('search', $result['action']);
        $this->assertSame(1, $result['env']['messagecount']);
        $this->assertSame(1, $result['env']['pagecount']);
        $this->assertSame(1, $result['env']['exists']);
        $this->assertTrue(strpos($result['exec'], 'this.display_message("1 messages found.","confirmation",0);') !== false);
        $this->assertTrue(strpos($result['exec'], 'this.set_rowcount("Messages 1 to 1 of 1","INBOX");') !== false);
        $this->assertTrue(strpos($result['exec'], 'this.set_pagetitle("Roundcube Webmail :: Search result");') !== false);
    }

    /**
     * Test search_input() method
     */
    function test_search_input()
    {
        $output = $this->initOutput(\rcmail_action::MODE_AJAX, 'mail', 'search');

        $result = \rcmail_action_mail_search::search_input('', 'subject,from', 'base', 'INBOX');
        $this->assertSame([], $result[0]);
        $this->assertSame('', $result[1]);

        $result = \rcmail_action_mail_search::search_input('test', 'subject,from', 'base', 'INBOX');
        $this->assertSame(['subject' => 'HEADER SUBJECT', 'from' => 'HEADER FROM'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('test', null, 'base', 'INBOX');
        $this->assertSame(['subject' => 'HEADER SUBJECT'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('body:test', 'subject,from', 'base', 'INBOX');
        $this->assertSame(['body' => 'BODY'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('to:test', '', 'base', 'INBOX');
        $this->assertSame(['to' => 'HEADER TO'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('reply-to:test', '', 'base', 'INBOX');
        $this->assertSame(['reply-to' => 'HEADER REPLY-TO'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('test', 'from,invalid entry', 'base', 'INBOX');
        $this->assertSame(['from' => 'HEADER FROM'], $result[0]);
        $this->assertSame('test', $result[1]);

        $result = \rcmail_action_mail_search::search_input('test', 'replyto', 'base', 'INBOX');
        $this->assertSame(['reply-to' => 'HEADER REPLY-TO', 'mail-reply-to' => 'HEADER MAIL-REPLY-TO'], $result[0]);
        $this->assertSame('test', $result[1]);
    }

    /**
     * Test data for test_search_interval_criteria()
     */
    static function data_search_interval_criteria()
    {
        $week  = new \DateInterval('P1W');
        $month = new \DateInterval('P1M');
        $year  = new \DateInterval('P1Y');

        return [
            ['', null],
            ['1W', 'SINCE ' . (new \DateTime('now'))->sub($week)->format('j-M-Y')],
            ['1M', 'SINCE ' . (new \DateTime('now'))->sub($month)->format('j-M-Y')],
            ['1Y', 'SINCE ' . (new \DateTime('now'))->sub($year)->format('j-M-Y')],
            ['-1W', 'BEFORE ' . (new \DateTime('now'))->sub($week)->format('j-M-Y')],
            ['-1M', 'BEFORE ' . (new \DateTime('now'))->sub($month)->format('j-M-Y')],
            ['-1Y', 'BEFORE ' . (new \DateTime('now'))->sub($year)->format('j-M-Y')],
        ];
    }

    /**
     * Test search_interval_criteria() method
     *
     * @dataProvider data_search_interval_criteria
     */
    #[DataProvider('data_search_interval_criteria')]
    function test_search_interval_criteria($input, $output)
    {
        $result = \rcmail_action_mail_search::search_interval_criteria($input);
        $this->assertSame($output, $result);
    }
}