summaryrefslogtreecommitdiff
path: root/src/operator-idle.cc
blob: 3ce9673a97c5f647005381ffd336756b918c4ed9 (plain)
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/**
 *  @file operator-idle.cc
 *  @brief  Operator for the IDLE command. Described in RFC2177 / June 1997.
 *  @author Andreas Aardal Hanssen
 *  @date 2002-2005
 */

#include "convert.h"
#include "depot.h"
#include "globals.h"
#include "iodevice.h"
#include "iofactory.h"
#include "mailbox.h"
#include "operators.h"
#include "pendingupdates.h"
#include "recursivedescent.h"
#include "session.h"

#include <iostream>
#include <string>

#include <unistd.h>

static bool directoryChangeNotification = false;

#ifdef HAVE_FNOTIFY  // GNU dependencies removed
#include <signal.h>
#include <stdio.h>

#include <fcntl.h>
#include <sys/select.h>
#include <sys/types.h>

void fnotifyEventHandler(int sig)
{
  directoryChangeNotification = true;
}
#endif

using namespace Binc;
using std::endl;

// Seconds between each poll. With FNOTIFY support, we can idle for 30
// minutes before timing out.
#ifdef HAVE_FNOTIFY
static const int POLLTIMEOUT = 30 * 60;
#else
static const int POLLTIMEOUT = 30;
#endif

IdleOperator::IdleOperator() {}

IdleOperator::~IdleOperator() {}

const std::string IdleOperator::getName() const
{
  return "IDLE";
}

Session::State IdleOperator::getState() const
{
  return Session::SELECTED;
}

Operator::ProcessResult IdleOperator::process(Depot &depot, Request &command)
{
  Mailbox *mailbox = depot.getSelected();
  std::string mailboxDir = depot.mailboxToFilename(mailbox->getName());

#ifdef HAVE_FNOTIFY
  // Check for FNOTIFY support.
  bool waitForNotification = false;
  int newfd = open((mailboxDir + "/new").c_str(), O_RDONLY);
  int curfd = open((mailboxDir + "/cur").c_str(), O_RDONLY);

  // Watch for notifications for renames, deletes or creates.
  if (newfd && curfd && !fcntl(newfd, F_NOTIFY, DN_RENAME | DN_DELETE | DN_CREATE)
      && !fcntl(curfd, F_NOTIFY, DN_RENAME | DN_DELETE | DN_CREATE))
  {
    struct sigaction fnotifyAction;
    fnotifyAction.sa_handler = fnotifyEventHandler;
    sigemptyset(&fnotifyAction.sa_mask);
    fnotifyAction.sa_flags = SA_RESTART;
    sigaction(SIGUSR1, &fnotifyAction, 0);
    fcntl(newfd, F_SETSIG, SIGUSR1);
    fcntl(curfd, F_SETSIG, SIGUSR1);
    waitForNotification = true;
  }
#endif

  // when not using FNOTIFY, we need to check the session timeout.
  time_t startTime = time(nullptr);
#ifdef HAVE_FNOTIFY
  ()startTime;  // removes a compile warning
#endif

  bincClient << "+ idling" << endl;
  bincClient.flush();

  // loop until the session times out or the client submits DONE.
  for (;;) {
    int maxfd = 0;
    fd_set readfds;
    FD_ZERO(&readfds);
    FD_SET(0, &readfds);

    // check for data from stdin. with FNOTIFY enabled, this select
    // will be interrupted by the notification signal.
    std::string input;
    struct timeval tv = {POLLTIMEOUT, 0};
    int ret = select(maxfd + 1, &readfds, nullptr, nullptr, &tv);

    // check if the select timed out.
    if (ret == 0) {
      Session &session = Session::getInstance();
#ifdef HAVE_FNOTIFY
      if (waitForNotification) {
        bincClient << "* BYE Timeout after " << session.timeout() << " seconds of inactivity."
                   << endl;
        session.setState(Session::LOGOUT);
        close(newfd);
        close(curfd);
        return Operator::ProcessResult::NOTHING;
      } else
#endif
          if (time(nullptr) > startTime + IDLE_TIMEOUT)
      {
        bincClient << "* BYE Timeout after " << IDLE_TIMEOUT << " seconds of inactivity."
                   << endl;
        session.setState(Session::LOGOUT);
        return Operator::ProcessResult::NOTHING;
      }
    }

    // unless the select failed, attempt to read client input.
    if (ret > 0 && FD_ISSET(0, &readfds)) {
      if (bincClient.readStr(&input) == false) {
        break;
      } else {
        uppercase(input);
        trim(input);
        if (input == "DONE") {
          break;
        } else {
          bincClient << "* BAD Syntax error: \"" << input << "\"" << endl;
          bincClient.flush();
          continue;
        }
      }
    }

    // at this point, we either got a directory change notification,
    // or the select simply timed out, in which case we poll.
    bool scanForChanges = false;
#ifdef HAVE_FNOTIFY
    if (directoryChangeNotification)
      scanForChanges = true;
    else if (!waitForNotification)
#endif
      scanForChanges = true;

    if (scanForChanges) {
      if (directoryChangeNotification) {
        // sleep the magic 1 second to ensure that anything that
        // arrived in new/ the last second isn't skipped by
        // pendingUpdates' scan.
        sleep(1);
      }

      // scan for changes in the mailbox and report to the client.
      if (!pendingUpdates(mailbox,
                          PendingUpdates::EXPUNGE | PendingUpdates::EXISTS
                              | PendingUpdates::RECENT | PendingUpdates::FLAGS,
                          true))
      {
        Session &session = Session::getInstance();
        bincClient << "* NO " << session.getLastError() << endl;
        bincWarning << "when scanning mailbox: " << session.getLastError() << endl;

#ifdef HAVE_FNOTIFY
        close(newfd);
        close(curfd);
#endif
        return Operator::ProcessResult::NO;
      }

#ifdef HAVE_FNOTIFY
      // if FNOTIFY is enabled, set it up again.
      if (waitForNotification) {
        directoryChangeNotification = false;

        // set up F_NOTIFY again.
        if (!fcntl(newfd, F_NOTIFY, DN_MODIFY | DN_RENAME | DN_DELETE | DN_CREATE)
            && !fcntl(curfd, F_NOTIFY, DN_MODIFY | DN_RENAME | DN_DELETE | DN_CREATE))
        {
          struct sigaction fnotifyAction;
          fnotifyAction.sa_handler = fnotifyEventHandler;
          sigemptyset(&fnotifyAction.sa_mask);
          fnotifyAction.sa_flags = SA_RESTART;
          sigaction(SIGUSR1, &fnotifyAction, 0);
        } else {
          waitForNotification = false;
        }
      }
#endif
      bincClient.flush();
    }
  }

#ifdef HAVE_FNOTIFY
  close(newfd);
  close(curfd);
#endif
  return Operator::ProcessResult::OK;
}

Parser::ParseResult IdleOperator::parse(Request &c_in)
{
  Session &session = Session::getInstance();

  if (c_in.getUidMode()) return Parser::ParseResult::REJECT;

  Parser::ParseResult res;
  if ((res = expectCRLF()) != Parser::ParseResult::ACCEPT) {
    session.setLastError("Expected CRLF after IDLE");
    return res;
  }

  c_in.setName("IDLE");
  return Parser::ParseResult::ACCEPT;
}