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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
/* $Id: FaxRecv.c++,v 1.18 2004/11/16 14:55:04 aidan Exp $ */
/*
* Copyright (c) 1990-1996 Sam Leffler
* Copyright (c) 1991-1996 Silicon Graphics, Inc.
* HylaFAX is a trademark of Silicon Graphics
*
* Permission to use, copy, modify, distribute, and sell this software and
* its documentation for any purpose is hereby granted without fee, provided
* that (i) the above copyright notices and this permission notice appear in
* all copies of the software and related documentation, and (ii) the names of
* Sam Leffler and Silicon Graphics may not be used in any advertising or
* publicity relating to the software without the specific, prior written
* permission of Sam Leffler and Silicon Graphics.
*
* THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
* EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
* WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
*
* IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
* ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
* OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
* WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
* LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE.
*/
#include "Sys.h"
#include <sys/file.h>
#include <ctype.h>
#include <errno.h>
#include "Dispatcher.h"
#include "tiffio.h"
#include "FaxServer.h"
#include "FaxRecvInfo.h"
#include "faxApp.h" // XXX
#include "t.30.h"
#include "config.h"
/*
* FAX Server Reception Protocol.
*/
bool
FaxServer::recvFax(const CallerID& cid, fxStr& emsg)
{
traceProtocol("RECV FAX: begin");
FaxRecvInfoArray docs;
FaxRecvInfo info;
bool faxRecognized = false;
emsg = "";
abortCall = false;
waitNotifyPid = 0;
/*
* Create the first file ahead of time to avoid timing
* problems with Class 1 modems. (Creating the file
* after recvBegin can cause part of the first page to
* be lost.)
*/
info.cidname = cid.name;
info.cidnumber = cid.number;
TIFF* tif = setupForRecv(info, docs, emsg);
if (tif) {
recvPages = 0; // total count of received pages
fileStart = Sys::now(); // count initial negotiation on failure
if (faxRecognized = modem->recvBegin(emsg)) {
/*
* If the system is busy then notifyRecvBegun may not return
* quickly. Thus we run it in a child process and move on.
*/
waitNotifyPid = fork();
switch (waitNotifyPid) {
case 0:
// NB: partially fill in info for notification call
notifyRecvBegun(info);
sleep(1); // XXX give parent time
exit(0);
case -1:
logError("Can not fork for non-priority processing.");
notifyRecvBegun(info);
break;
default:
Dispatcher::instance().startChild(waitNotifyPid, this);
break;
}
if (!recvDocuments(tif, info, docs, emsg)) {
traceProtocol("RECV FAX: %s", (const char*) emsg);
modem->recvAbort();
}
if (!modem->recvEnd(emsg))
traceProtocol("RECV FAX: %s", (const char*) emsg);
} else {
traceProtocol("RECV FAX: %s", (const char*) emsg);
TIFFClose(tif);
}
} else
traceServer("RECV FAX: %s", (const char*) emsg);
/*
* Possibly issue a command upon successful reception.
*/
if (info.npages > 0 && info.reason == "")
modem->recvSucceeded();
/*
* Now that the session is completed, do local processing
* that might otherwise slow down the protocol (and potentially
* cause timing problems).
*/
for (u_int i = 0, n = docs.length(); i < n; i++) {
const FaxRecvInfo& ri = docs[i];
if (ri.npages == 0)
Sys::unlink(ri.qfile);
else
Sys::chmod(ri.qfile, recvFileMode);
if (faxRecognized)
notifyRecvDone(ri);
}
traceProtocol("RECV FAX: end");
return (faxRecognized);
}
int
FaxServer::getRecvFile(fxStr& qfile, fxStr& emsg)
{
u_long seqnum = Sequence::getNext(FAX_RECVDIR "/" FAX_SEQF, emsg);
if (seqnum == -1)
return -1;
qfile = fxStr::format(FAX_RECVDIR "/fax" | Sequence::format | ".tif", seqnum);
int ftmp = Sys::open(qfile, O_RDWR|O_CREAT|O_EXCL, recvFileMode);
if (ftmp < 0)
emsg = "Failed to find unused filename";
return ftmp;
}
/*
* Create and lock a temp file for receiving data.
*/
TIFF*
FaxServer::setupForRecv(FaxRecvInfo& ri, FaxRecvInfoArray& docs, fxStr& emsg)
{
int ftmp = getRecvFile(ri.qfile, emsg);
if (ftmp >= 0) {
ri.commid = getCommID(); // should be set at this point
ri.npages = 0; // mark it to be deleted...
docs.append(ri); // ...add it in to the set
TIFF* tif = TIFFFdOpen(ftmp, ri.qfile, "w");
if (tif != NULL)
return (tif);
Sys::close(ftmp);
emsg = fxStr::format("Unable to open TIFF file %s for writing",
(const char*) ri.qfile);
ri.reason = emsg; // for notifyRecvDone
} else
emsg.insert("Unable to create temp file for received data: ");
return (NULL);
}
/*
* Receive one or more documents.
*/
bool
FaxServer::recvDocuments(TIFF* tif, FaxRecvInfo& info, FaxRecvInfoArray& docs, fxStr& emsg)
{
bool recvOK;
u_int ppm = PPM_EOP;
pageStart = Sys::now();
for (;;) {
bool okToRecv = true;
fxStr reason;
modem->getRecvSUB(info.subaddr); // optional subaddress
/*
* Check a received TSI/PWD against the list of acceptable
* patterns defined for the server. This form of access
* control depends on the sender passing a valid TSI/PWD.
* Note that to accept/reject unspecified values one
* should match "<UNSPECIFIED>".
*
* NB: Caller-ID access control is done elsewhere; prior
* to answering a call.
*/
if (!modem->getRecvTSI(info.sender)) // optional TSI
info.sender = "<UNSPECIFIED>";
if (qualifyTSI != "") {
okToRecv = isTSIOk(info.sender);
reason = "Permission denied (unnacceptable client TSI)";
traceServer("%s TSI \"%s\"", okToRecv ? "ACCEPT" : "REJECT",
(const char*) info.sender);
}
if (!modem->getRecvPWD(info.passwd)) // optional PWD
info.passwd = "<UNSPECIFIED>";
if (qualifyPWD != "") {
okToRecv = isPWDOk(info.passwd);
reason = "Permission denied (unnacceptable client PWD)";
traceServer("%s PWD \"%s\"", okToRecv ? "ACCEPT" : "REJECT",
(const char*) info.passwd);
}
if (!okToRecv) {
emsg = reason;
info.time = (u_int) getFileTransferTime();
info.reason = emsg;
docs[docs.length()-1] = info;
notifyDocumentRecvd(info);
TIFFClose(tif);
return (false);
}
setServerStatus("Receiving from \"%s\"", (const char*) info.sender);
recvOK = recvFaxPhaseD(tif, info, ppm, emsg);
TIFFClose(tif);
info.time = (u_int) getFileTransferTime();
info.reason = emsg;
docs[docs.length()-1] = info;
/*
* If syslog is busy then notifyDocumentRecvd may not return
* quickly. Thus we run it in a child process and move on.
*/
pid_t pid = waitNotifyPid;
waitNotifyPid = fork();
switch (waitNotifyPid) {
case 0:
if (pid > 0) (void) Sys::waitpid(pid);
notifyDocumentRecvd(info);
sleep(1); // XXX give parent time
exit(0);
case -1:
logError("Can not fork for non-priority logging.");
notifyDocumentRecvd(info);
break;
default:
Dispatcher::instance().startChild(waitNotifyPid, this);
break;
}
if (!recvOK || ppm == PPM_EOP)
return (recvOK);
/*
* Setup state for another file.
*/
tif = setupForRecv(info, docs, emsg);
if (tif == NULL)
return (false);
fileStart = pageStart = Sys::now();
if (!modem->recvEOMBegin(emsg))
return (false);
}
/*NOTREACHED*/
}
/*
* Receive Phase B protocol processing.
*/
bool
FaxServer::recvFaxPhaseD(TIFF* tif, FaxRecvInfo& info, u_int& ppm, fxStr& emsg)
{
fxStr id = info.sender;
if (info.cidname.length() || info.cidnumber.length()) id.append("\n" | info.cidname);
if (info.cidnumber.length()) id.append("\n" | info.cidnumber);
do {
if (++recvPages > maxRecvPages) {
emsg = "Maximum receive page count exceeded, job terminated";
return (false);
}
if (!modem->recvPage(tif, ppm, emsg, id))
return (false);
info.npages++;
info.time = (u_int) getPageTransferTime();
info.params = modem->getRecvParams();
/*
* If syslog is busy then notifyPageRecvd may not return quickly.
* Thus we run it in a child process and move on. Timestamps
* in syslog cannot be expected to have exact precision anyway.
*/
pid_t pid = waitNotifyPid;
waitNotifyPid = fork();
switch (waitNotifyPid) {
case 0:
if (pid > 0) (void) Sys::waitpid(pid);
notifyPageRecvd(tif, info, ppm);
sleep(1); // XXX give parent time
exit(0);
case -1:
logError("Can not fork for non-priority logging.");
notifyPageRecvd(tif, info, ppm);
break;
default:
Dispatcher::instance().startChild(waitNotifyPid, this);
break;
}
if (emsg != "") return (false); // got page with fatal error
if (PPM_PRI_MPS <= ppm && ppm <= PPM_PRI_EOP) {
emsg = "Procedure interrupt received, job terminated";
return (false);
}
pageStart = Sys::now(); // reset for next page
} while (ppm == PPM_MPS || ppm == PPM_PRI_MPS);
return (true);
}
void
FaxServer::notifyRecvBegun(const FaxRecvInfo&)
{
}
/*
* Handle notification that a page has been received.
*/
void
FaxServer::notifyPageRecvd(TIFF*, const FaxRecvInfo& ri, int)
{
traceServer("RECV FAX (%s): from %s, page %u in %s, %s, %s, %s, %s"
, (const char*) ri.commid
, (const char*) ri.sender
, ri.npages
, fmtTime((time_t) ri.time)
, (ri.params.ln == LN_A4 ? "A4" : ri.params.ln == LN_B4 ? "B4" : "INF")
, ri.params.verticalResName()
, ri.params.dataFormatName()
, ri.params.bitRateName()
);
}
/*
* Handle notification that a document has been received.
*/
void
FaxServer::notifyDocumentRecvd(const FaxRecvInfo& ri)
{
traceServer("RECV FAX (%s): %s from %s, route to %s, %u pages in %s"
, (const char*) ri.commid
, (const char*) ri.qfile
, (const char*) ri.sender
, ri.subaddr != "" ? (const char*) ri.subaddr : "<unspecified>"
, ri.npages
, fmtTime((time_t) ri.time)
);
}
/*
* Handle final actions associated with a document being received.
*/
void
FaxServer::notifyRecvDone(const FaxRecvInfo& ri)
{
if (ri.reason != "")
traceServer("RECV FAX (%s): session with %s terminated abnormally: %s"
, (const char*) ri.commid
, (const char*) ri.sender
, (const char*) ri.reason
);
}
|