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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
|
/* $Id$ */
/*
* 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 <stdio.h>
#include "Sys.h"
#include "Class2.h"
#include "ModemConfig.h"
#include "FaxRequest.h"
/*
* Send Protocol for Class-2-style modems.
*/
bool
Class2Modem::sendSetup(FaxRequest& req, const Class2Params& dis, Status& eresult)
{
const char* cmdFailed = " (modem command failed)";
/*
* PWD and SUB setup don't belong here, they should be done
* in setupSetupPhaseB at which time we know whether or not
* the receiver supports them. However since no status message
* is defined for T.class2 such that we can determine this
* information and since some modems will undoubtedly require
* all session state to be setup prior to the initial call
* we'll send this stuff to the modem here (for now at least).
*/
if (req.passwd != "" && pwCmd != "" && !class2Cmd(pwCmd, req.passwd)) {
eresult = Status(204, "Unable to send password%s", cmdFailed);
return (false);
}
if (req.subaddr != "" && saCmd != "" && !class2Cmd(saCmd, req.subaddr)) {
eresult = Status(205, "Unable to send subaddress%s", cmdFailed);
return (false);
}
if (minsp != BR_2400 && !class2Cmd(minspCmd, minsp)) {
eresult = Status(206, "Unable to restrict minimum transmit speed to %s%s",
Class2Params::bitRateNames[req.minbr], cmdFailed);
return (false);
}
if (conf.class2DDISCmd != "") {
if (!class2Cmd(conf.class2DDISCmd, dis, false)) {
eresult = Status(207, "Unable to setup session parameters "
"prior to call%s", cmdFailed);
return (false);
}
params = dis;
}
hadHangup = false;
return (FaxModem::sendSetup(req, dis, eresult));
}
/*
* Process the response to a dial command.
*/
CallStatus
Class2Modem::dialResponse(Status& eresult)
{
ATResponse r;
hangupCode[0] = '\0';
do {
/*
* Use a dead-man timeout since some
* modems seem to get hosed and lockup.
*/
r = atResponse(rbuf, conf.dialResponseTimeout);
// Blacklisting (see notes in Class1Send.c++)
if (strncmp(rbuf, "BLACKLISTED", 11) == 0
|| strncmp(rbuf, "DELAYED", 7) == 0
|| strncmp(rbuf, "DIALING DISABLED", 16) == 0) {
eresult = Status(10, "Blacklisted by modem");
return (NOCARRIER);
}
switch (r) {
case AT_ERROR: return (ERROR); // error in dial command
case AT_BUSY: return (BUSY); // busy signal
case AT_NOCARRIER: return (NOCARRIER); // no carrier detected
case AT_OK: return (NOCARRIER); // (for AT&T DataPort)
case AT_NODIALTONE: return (NODIALTONE);// local phone connection hosed
case AT_NOANSWER: return (NOANSWER); // no answer or ring back
case AT_FHNG: // Class 2 hangup code
eresult = hangupStatus(hangupCode);;
switch (atoi(hangupCode)) {
case 1: return (NOANSWER); // Ring detected w/o handshake
case 3: return (NOANSWER); // No loop current (???)
case 4: return (NOANSWER); // Ringback detected, no answer
case 5: return (NOANSWER); // Ringback ", no answer w/o CED
case 10: return (NOFCON); // Unspecified Phase A error
case 11: return (NOFCON); // No answer (T.30 timeout)
}
break;
case AT_FCON: return (OK); // fax connection
case AT_TIMEOUT: return (FAILURE); // timed out w/o response
case AT_CONNECT: return (DATACONN); // modem thinks data connection
}
} while (r == AT_OTHER && isNoise(rbuf));
return (FAILURE);
}
#define BATCH_FIRST 1
#define BATCH_LAST 2
/*
* Process the string of session-related information
* sent to the caller on connecting to a fax machine.
*/
FaxSendStatus
Class2Modem::getPrologue(Class2Params& dis, bool& hasDoc, Status& eresult, u_int& batched)
{
bool gotParams = false;
hasDoc = false;
if (batched & BATCH_FIRST) { // only for the first document
ATResponse r;
for (;;) {
r = atResponse(rbuf, conf.t1Timer);
switch (r) {
case AT_FPOLL:
hasDoc = true;
protoTrace("REMOTE has document to POLL");
break;
case AT_FDIS:
gotParams = parseClass2Capabilities(skipStatus(rbuf), dis, true);
break;
case AT_FNSF:
recvNSF(NSF(skipStatus(rbuf), conf.class2HexNSF));
break;
case AT_FCSI:
recvCSI(stripQuotes(skipStatus(rbuf)));
break;
case AT_OK:
if (gotParams)
return (send_ok);
/* fall thru... */
case AT_TIMEOUT:
case AT_EMPTYLINE:
case AT_NOCARRIER:
case AT_NODIALTONE:
case AT_NOANSWER:
case AT_ERROR:
processHangup("20"); // Unspecified Phase B error
/* fall thru... */
case AT_FHNG:
if (r == AT_FHNG)
waitFor(AT_OK);
eresult = hangupStatus(hangupCode);
return (send_retry);
}
}
} else {
/*
* We already have the remote DIS. Class 2 protocol says to now send
* +FIS and then +FDT, expecting CONNECT, so we skip this "prologue".
*/
return (send_ok);
}
}
/*
* Initiate data transfer from the host to the modem when
* doing a send. Note that some modems require that we
* wait for an XON from the modem in response to the +FDT,
* before actually sending any data.
*/
bool
Class2Modem::dataTransfer()
{
bool status = false;
if (xmitWaitForXON) {
/*
* Wait for XON (DC1) from the modem after receiving
* CONNECT and before sending page data. If XON/XOFF
* flow control is in use then disable it temporarily
* so that we can read the input stream for DC1.
*/
if (flowControl == FLOW_XONXOFF)
setXONXOFF(FLOW_NONE, getOutputFlow(), ACT_NOW);
}
u_short tries = 0;
ATResponse r;
do {
atCmd("AT+FDT", AT_NOTHING, conf.pageStartTimeout);
do {
r = atResponse(rbuf, conf.pageStartTimeout);
} while (r == AT_OTHER || r > AT_FHNG); // ignore all Class 2-specific other than +FHNG
} while (!hadHangup && r == AT_OK && tries++ < 3);
status = (r == AT_CONNECT);
if (xmitWaitForXON) {
if (status) {
protoTrace("SEND wait for XON");
int c;
startTimeout(10*1000); // 5 seconds *should* be enough
while ((c = getModemChar(0)) != EOF) {
modemTrace("--> [1:%c]", c);
if (c == DC1)
break;
}
stopTimeout("waiting for XON before sending page data");
status = (c == DC1);
}
if (flowControl == FLOW_XONXOFF) {
FlowControl oiFlow = getInputFlow();
setXONXOFF(oiFlow, getOutputFlow(), ACT_NOW);
}
}
return (status);
}
static bool
pageInfoChanged(const Class2Params& a, const Class2Params& b)
{
return (a.vr != b.vr || a.wd != b.wd || a.ln != b.ln || a.df != b.df || a.br != b.br);
}
/*
* Send the specified document using the supplied
* parameters. The pph is the post-page-handling
* indicators calculated prior to intiating the call.
*/
FaxSendStatus
Class2Modem::sendPhaseB(TIFF* tif, Class2Params& next, FaxMachineInfo& info,
fxStr& pph, Status& eresult, u_int& batched, PageType pt)
{
int ntrys = 0; // # retraining/command repeats
u_int ppm, previousppm = 0;
setDataTimeout(180, next.br); // 180 seconds for 1024 byte writes, increased for potential ECM delays
hangupCode[0] = '\0';
bool transferOK;
bool morePages = false;
do {
transferOK = false;
if (abortRequested())
goto failed;
/*
* Check the next page to see if the transfer
* characteristics change. If so, update the
* current T.30 session parameters.
*/
if (pageInfoChanged(params, next)) {
if (!class2Cmd(disCmd, next, false)) {
eresult = Status(208, "Unable to set session parameters");
break;
}
params = next;
}
/*
* We need to decode the PPH here. If the page is skipped,
* we log it, but we need to go into the if code below to
* handle the full pph stipping, tiff stuff correctly, but
* we need to not send the page if it's skipped.
*/
if (!decodePPM(pph, ppm, eresult))
goto failed;
if (ppm == PPH_SKIP)
protoTrace("Skiping page %d", FaxModem::getPageNumber());
if (ppm == PPH_SKIP || (dataTransfer() && sendPage(tif, decodePageChop(pph, params), pt == PAGE_COVER))) {
/*
* Page transferred, process post page response from
* remote station (XXX need to deal with PRI requests).).
*/
morePages = !TIFFLastDirectory(tif);
if (ppm == PPM_EOP && !(batched & BATCH_LAST)) {
ppm = PPM_EOM;
// this should force us to resend disCmd, since some modems don't remember
params.vr = (u_int) -1; }
tracePPM("SEND send", ppm);
u_int ppr;
/*
* pageDone() knows how to handle PPH_SKIP, and give us
* a simulated ppr
*/
if (pageDone(ppm, ppr)) {
if (ppm == PPM_EOP && morePages && hadHangup)
{
hadHangup = false;
protoTrace("All done sending (normal hangup with skip), suppressing for now");
}
tracePPR("SEND recv", ppr);
switch (ppr) {
case PPR_MCF: // page good
case PPR_PIP: // page good, interrupt requested
case PPR_RTP: // page good, retrain requested
ignore:
countPage(ppm == PPH_SKIP ? PAGE_SKIP : pt); // bump page count
notifyPageSent(tif, ppm == PPH_SKIP ? PAGE_SKIP : pt);// update server
if (pph[2] == 'Z')
pph.remove(0,2+5+1); // discard page-chop+handling
else
pph.remove(0,3); // discard page-handling info
ntrys = 0;
if (morePages) {
if (ppr == PPR_PIP) {
eresult = Status(280, "Procedure interrupt (operator intervention)");
goto failed;
}
if (!TIFFReadDirectory(tif)) {
eresult = Status(302, "Problem reading document directory");
goto failed;
}
if (ppr == PPR_MCF) {
/*
* The session parameters cannot change except following
* the reception of an RTN or RTP signal or the transmission
* of an EOM signal.
*
* Since we did not receive RTN or RTP, and since batching (EOM)
* triggers retraining in other ways, we require that the
* next page have the same characteristics as this page.
*/
next = params;
}
}
transferOK = true;
break;
case PPR_RTN: // page bad, retrain requested
switch( conf.rtnHandling ){
case RTN_RETRANSMITIGNORE:
if (ntrys < 2) break;
case RTN_IGNORE:
goto ignore; // ignore error and trying to send next page
case RTN_GIVEUP:
eresult = Status(281, "Unable to transmit page (giving up after RTN)");
goto failed; // "over and out"
}
// case RTN_RETRANSMIT
if (++ntrys >= 3) {
eresult = Status(282, "Unable to transmit page (giving up after 3 attempts)");
break;
}
if (params.br == BR_2400) {
eresult = Status(283, "Unable to transmit page (NAK at all possible signalling rates)");
break;
}
next.br--;
morePages = true; // retransmit page
transferOK = true;
break;
case PPR_PIN: // page bad, interrupt requested
eresult = Status(284, "Unable to transmit page (NAK with operator intervention)");
goto failed;
default:
eresult = Status(285, "Modem protocol error (unknown post-page response)");
break;
}
} else {
/*
* We received no PPR.
*/
if (ppm == PPM_EOM && (batched & BATCH_FIRST)) {
eresult = Status(286, "Batching protocol error");
protoTrace("The destination appears to not support batching.");
return (send_batchfail);
}
}
} else {
/*
* We were unable to negotiate settings and transfer page image data.
*/
if (previousppm == PPM_EOM) {
eresult = Status(286, "Batching protocol error");
protoTrace("The destination appears to not support batching.");
return (send_batchfail);
}
}
previousppm = ppm;
} while (transferOK && morePages && !hadHangup);
if (!transferOK) {
if (eresult.value() == 0) {
if (hangupCode[0])
eresult = hangupStatus(hangupCode);
else
eresult = Status(287, "Communication failure during Phase B/C");
}
sendAbort(); // terminate session
} else if (hadHangup && morePages) {
/*
* Modem hung up before the transfer completed (e.g. PPI
* modems which get confused when they receive RTN and return
* +FHNG:0). Setup an error return so that the job will
* be retried.
*/
transferOK = false;
eresult = Status(288, "Communication failure during Phase B/C (modem protocol botch)");
}
return (transferOK ? send_ok : send_retry);
failed:
sendAbort();
return (send_failed);
}
/*
* Send one page of data to the modem, imaging any
* tag line that is configured. We also implement
* page chopping based on the calculation done by
* faxq during document preparation.
*
* Note that we read an entire page of encoded data
* into memory before sending it to the modem. This
* is done to avoid timing problems when the document
* is comprised of multiple strips.
*/
bool
Class2Modem::sendPageData(TIFF* tif, u_int pageChop, bool cover)
{
bool rc = true;
/* For debugging purposes we may want to write the image-data to file. */
if (conf.saverawimage) imagefd = Sys::open("/tmp/out.fax", O_RDWR|O_CREAT|O_EXCL);
tstrip_t nstrips = TIFFNumberOfStrips(tif);
if (nstrips > 0) {
/*
* RTFCC may mislead us here, so we temporarily
* adjust params.
*/
Class2Params newparams = params;
uint16 compression;
TIFFGetField(tif, TIFFTAG_COMPRESSION, &compression);
if (compression != COMPRESSION_CCITTFAX4) {
uint32 g3opts = 0;
TIFFGetField(tif, TIFFTAG_GROUP3OPTIONS, &g3opts);
if ((g3opts & GROUP3OPT_2DENCODING) == DF_2DMR)
params.df = DF_2DMR;
else
params.df = DF_1DMH;
} else
params.df = DF_2DMMR;
/*
* Correct bit order of data if not what modem expects.
*/
uint16 fillorder;
TIFFGetFieldDefaulted(tif, TIFFTAG_FILLORDER, &fillorder);
const u_char* bitrev =
TIFFGetBitRevTable(fillorder != sendFillOrder);
/*
* Setup tag line processing.
*/
bool doTagLine = setupTagLineSlop(params);
u_int ts = getTagLineSlop();
/*
* Calculate total amount of space needed to read
* the image into memory (in its encoded format).
*/
uint32* stripbytecount;
(void) TIFFGetField(tif, TIFFTAG_STRIPBYTECOUNTS, &stripbytecount);
tstrip_t strip;
u_long totdata = 0;
for (strip = 0; strip < nstrips; strip++)
totdata += stripbytecount[strip];
/*
* Read the image into memory.
*/
u_char* data = new u_char[totdata+ts];
u_int off = ts; // skip tag line slop area
for (strip = 0; strip < nstrips; strip++) {
uint32 sbc = stripbytecount[strip];
if (sbc > 0 && TIFFReadRawStrip(tif, strip, data+off, sbc) >= 0)
off += (u_int) sbc;
}
totdata -= pageChop; // deduct trailing white space not sent
/*
* Image the tag line, if intended, and then
* pass the data to the modem, filtering DLE's
* and being careful not to get hung up.
*/
u_char* dp;
if (doTagLine) {
u_long totbytes = totdata;
dp = imageTagLine(data+ts, fillorder, params, totbytes, cover);
totdata = (params.df == DF_2DMMR) ? totbytes : totdata+ts - (dp-data);
} else
dp = data;
uint32 rows = 0;
if (conf.softRTFCC && !conf.class2RTFCC && params.df != newparams.df) {
switch (params.df) {
case DF_1DMH:
protoTrace("Reading MH-compressed image file");
break;
case DF_2DMR:
protoTrace("Reading MR-compressed image file");
break;
case DF_2DMMR:
protoTrace("Reading MMR-compressed image file");
break;
}
dp = convertPhaseCData(dp, totdata, fillorder, params, newparams, rows);
params = newparams; // revert back
}
/*
* correct broken Phase C (T.4) data if necessary
*/
if (params.df < DF_2DMMR) {
correctPhaseCData(dp, totdata, fillorder, params, rows);
} else if (params.df == DF_JBIG) {
// JBIG needs the data bit-reversed as we get it backwards from the library
TIFFReverseBits(dp, totdata);
}
if (imagefd > 0) Sys::write(imagefd, (const char*) dp, (u_int) totdata);
beginTimedTransfer();
rc = putModemDLEData(dp, (u_int) totdata, bitrev, getDataTimeout(), conf.doPhaseCDebug);
endTimedTransfer();
protoTrace("SENT %u bytes of data", totdata);
}
if (imagefd > 0) {
Sys::close(imagefd);
imagefd = 0;
}
return (rc);
}
/*
* Send RTC to terminate a page.
*/
bool
Class2Modem::sendRTC(Class2Params params)
{
if (params.df > DF_2DMR) return (true); // nothing to do
// these are intentionally reverse-encoded in order to keep
// rtcRev and bitrev in sendPage() in agreement
static const u_char RTC1D[9] =
{ 0x00,0x08,0x80,0x00,0x08,0x80,0x00,0x08,0x80 };
static const u_char RTC2D[10] =
{ 0x00,0x18,0x00,0x03,0x60,0x00,0x0C,0x80,0x01,0x30 };
protoTrace("SEND %s RTC", params.is2D() ? "2D" : "1D");
if (params.is2D())
return putModemDLEData(RTC2D, sizeof (RTC2D), rtcRev, getDataTimeout());
else
return putModemDLEData(RTC1D, sizeof (RTC1D), rtcRev, getDataTimeout());
}
/*
* Abort an active Class 2 session.
*/
void
Class2Modem::sendAbort()
{
if (!hadHangup)
(void) atCmd(abortCmd);
}
|