开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 通讯/手机编程 > 传真(Fax)编程 > 查看源码
FaxRequest.c++
资源名称：hylafax-5.3.0.tar.gz　[点击查看]
上传用户：weiyuanprp
上传日期：2020-05-20
资源大小：1169k
文件大小：22k
源码类别：

传真(Fax)编程

开发平台：

C/C++

FaxRequest.c++：源码内容
  1. /* $Id: FaxRequest.c++,v 1.18 2008/09/16 05:39:07 faxguy Exp $ */
  2. /*
  3.  * Copyright (c) 1990-1996 Sam Leffler
  4.  * Copyright (c) 1991-1996 Silicon Graphics, Inc.
  5.  * HylaFAX is a trademark of Silicon Graphics
  6.  *
  7.  * Permission to use, copy, modify, distribute, and sell this software and 
  8.  * its documentation for any purpose is hereby granted without fee, provided
  9.  * that (i) the above copyright notices and this permission notice appear in
  10.  * all copies of the software and related documentation, and (ii) the names of
  11.  * Sam Leffler and Silicon Graphics may not be used in any advertising or
  12.  * publicity relating to the software without the specific, prior written
  13.  * permission of Sam Leffler and Silicon Graphics.
  14.  * 
  15.  * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  16.  * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  17.  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  18.  * 
  19.  * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  20.  * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  21.  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  22.  * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  23.  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  24.  * OF THIS SOFTWARE.
  25.  */
  26. #include "Sys.h"
  27. #include "FaxRequest.h"
  28. #include "StackBuffer.h"
  29. #include "class2.h"
  30. #include "config.h"
  31. #include "hash.h" // pre-calculated hash values
  33. #include <ctype.h>
  34. #include <errno.h>
  36. /*
  37.  * HylaFAX job request file handling.
  38.  */
  40. extern void vlogError(const char* fmt, va_list ap);
  41. extern void logError(const char* fmt ...);
  43. FaxRequest::FaxRequest(const fxStr& qf, int f) : qfile(qf)
  44. {
  45.     reset();
  46.     fd = f;
  47. }
  49. void
  50. FaxRequest::reset(void)
  51. {
  52.     tts = 0;
  53.     killtime = 0;
  54.     retrytime = 0;
  55.     state = 0;
  56.     status = send_retry;
  57.     pri = (u_short) -1;
  58.     usrpri = FAX_DEFPRIORITY;
  59.     pagewidth = pagelength = resolution = 0;
  60.     npages = totpages = skippages = skippedpages = nocountcover = 0;
  61.     ntries = ndials = 0;
  62.     minbr = BR_2400;
  63.     desiredbr = BR_33600;
  64.     desiredst = ST_0MS;
  65.     desiredec = EC_ENABLE256;
  66.     desireddf = DF_2DMMR;
  67.     desiredtl = 0;
  68.     totdials = 0, maxdials = (u_short) FAX_REDIALS;
  69.     tottries = 0, maxtries = (u_short) FAX_RETRIES;
  70.     useccover = true;
  71.     usexvres = false;
  72.     serverdocover = false;
  73.     ignoremodembusy = false;
  74.     pagechop = chop_default;
  75.     chopthreshold = -1;
  76.     csi = fxStr::null;
  77.     nsf = fxStr::null;
  78.     notify = no_notice;
  79.     jobtype = "facsimile"; // for compatibility w/ old clients
  80.     writeQFilePid = 0;
  81. }
  83. FaxRequest::~FaxRequest()
  84. {
  85.     if (fd != -1)
  86. Sys::close(fd);
  87. }
  89. #define N(a) (sizeof (a) / sizeof (a[0]))
  91. FaxRequest::stringval FaxRequest::strvals[] = {
  92.     { "canonical", &FaxRequest::canonical },
  93.     { "external", &FaxRequest::external },
  94.     { "number", &FaxRequest::number },
  95.     { "mailaddr", &FaxRequest::mailaddr },
  96.     { "sender", &FaxRequest::sender },
  97.     { "jobid", &FaxRequest::jobid },
  98.     { "jobtag", &FaxRequest::jobtag },
  99.     { "pagehandling", &FaxRequest::pagehandling },
  100.     { "modem", &FaxRequest::modem },
  101.     { "modemused", &FaxRequest::modemused },
  102.     { "faxnumber", &FaxRequest::faxnumber },
  103.     { "faxname", &FaxRequest::faxname },
  104.     { "tsi", &FaxRequest::tsi },
  105.     { "receiver", &FaxRequest::receiver },
  106.     { "company", &FaxRequest::company },
  107.     { "location", &FaxRequest::location },
  108.     { "voice", &FaxRequest::voice },
  109.     { "fromcompany", &FaxRequest::fromcompany },
  110.     { "fromlocation", &FaxRequest::fromlocation },
  111.     { "fromvoice", &FaxRequest::fromvoice },
  112.     { "regarding", &FaxRequest::regarding },
  113.     { "comments", &FaxRequest::comments },
  114.     { "cover", &FaxRequest::cover },
  115.     { "client", &FaxRequest::client },
  116.     { "owner", &FaxRequest::owner },
  117.     { "groupid", &FaxRequest::groupid },
  118.     { "signalrate", &FaxRequest::sigrate },
  119.     { "dataformat", &FaxRequest::df },
  120.     { "jobtype", &FaxRequest::jobtype },
  121.     { "tagline", &FaxRequest::tagline },
  122.     { "subaddr", &FaxRequest::subaddr },
  123.     { "passwd", &FaxRequest::passwd },
  124.     { "doneop", &FaxRequest::doneop },
  125.     { "commid", &FaxRequest::commid },
  126.     { "csi", &FaxRequest::csi },
  127.     { "nsf", &FaxRequest::nsf },
  128.     { "timeofday", &FaxRequest::timeofday },
  129.     { "errorcode", &FaxRequest::errorcode },
  130. };
  131. FaxRequest::shortval FaxRequest::shortvals[] = {
  132.     { "state", &FaxRequest::state },
  133.     { "npages", &FaxRequest::npages },
  134.     { "skippages", &FaxRequest::skippages },
  135.     { "nocountcover", &FaxRequest::nocountcover },
  136.     { "serverdocover", &FaxRequest::serverdocover },
  137.     { "ignoremodembusy",&FaxRequest::ignoremodembusy },
  138.     { "totpages", &FaxRequest::totpages },
  139.     { "ntries", &FaxRequest::ntries },
  140.     { "ndials", &FaxRequest::ndials },
  141.     { "totdials", &FaxRequest::totdials },
  142.     { "maxdials", &FaxRequest::maxdials },
  143.     { "tottries", &FaxRequest::tottries },
  144.     { "maxtries", &FaxRequest::maxtries },
  145.     { "pagewidth", &FaxRequest::pagewidth },
  146.     { "resolution", &FaxRequest::resolution },
  147.     { "pagelength", &FaxRequest::pagelength },
  148.     { "priority", &FaxRequest::usrpri },
  149.     { "schedpri", &FaxRequest::pri },
  150.     { "minbr", &FaxRequest::minbr },
  151.     { "desiredbr", &FaxRequest::desiredbr },
  152.     { "desiredst", &FaxRequest::desiredst },
  153.     { "desiredec", &FaxRequest::desiredec },
  154.     { "desireddf", &FaxRequest::desireddf },
  155.     { "desiredtl", &FaxRequest::desiredtl },
  156.     { "useccover", &FaxRequest::useccover },
  157.     { "usexvres", &FaxRequest::usexvres },
  158. };
  159. FaxRequest::intval FaxRequest::intvals[] = {
  160.     { "skippedpages", &FaxRequest::skippedpages },
  161. };
  162. const char* FaxRequest::opNames[18] = {
  163.     "fax",
  164.     "tiff",
  165.     "!tiff",
  166.     "pdf",
  167.     "!pdf",
  168.     "postscript",
  169.     "!postscript",
  170.     "pcl",
  171.     "!pcl",
  172.     "data",
  173.     "!data",
  174.     "poll",
  175.     "page",
  176.     "!page",
  177.     "uucp",
  178.     "15", "16", "17"
  179. };
  180. const char* FaxRequest::notifyVals[4] = {
  181.     "none", // no_notice
  182.     "when done", // when_done
  183.     "when requeued", // when_requeued
  184.     "when done+requeued" // when_done|when_requeued
  185. };
  186. const char* FaxRequest::chopVals[4] = {
  187.     "default", // chop_default
  188.     "none", // chop_none
  189.     "all", // chop_all
  190.     "last" // chop_last
  191. };
  193. /*
  194.  * Parse the contents of a job description file.
  195.  */
  196. bool
  197. FaxRequest::readQFile(bool& rejectJob)
  198. {
  199.     rejectJob = false;
  200.     lineno = 0;
  201.     lseek(fd, 0L, SEEK_SET); // XXX should only for re-read
  202.     /*
  203.      * Read the file contents in with one read.  If the
  204.      * file is too large to fit in the buffer allocated
  205.      * on the stack then dynamically allocate one.  The
  206.      * 2K size was chosen based on statistics; most files
  207.      * are less than 1K in size.
  208.      *
  209.      * NB: we don't mmap the file because we're going to
  210.      *     modify its contents in memory during parsing
  211.      *     (plus it's not clear that mmap is a win for
  212.      *     such a small file).
  213.      */
  214.     struct stat sb;
  215.     Sys::fstat(fd, sb);
  216.     if (sb.st_size < 2) {
  217. error("Corrupted file (too small)");
  218. return (false);
  219.     }
  220.     char stackbuf[2048];
  221.     char* buf = stackbuf;
  222.     char* bp = buf;
  223.     if (sb.st_size > (off_t)sizeof(stackbuf)-1) // extra byte for terminating 
  224. bp = buf = new char[sb.st_size+1];
  225.     if (Sys::read(fd, bp, (u_int) sb.st_size) != sb.st_size) {
  226. error("Read error: %s", strerror(errno));
  227. if (buf != stackbuf)
  228.     delete [] buf;
  229. return (false);
  230.     }
  231.     /*
  232.      * Force n-termination of the last line in the
  233.      * file.  This simplifies the logic below by always
  234.      * being able to look for n-termination and not
  235.      * worry about running off the end of the buffer.
  236.      */
  237.     char* ep = bp+sb.st_size;
  238.     if (ep[-1] != 'n')
  239. ep[0] = 'n';
  240.     do {
  241. lineno++;
  242. /*
  243.  * Collect command identifier and calculate hash.
  244.  * The hash value is used to identify the command
  245.  * using a set of pre-calculated values (see the
  246.  * mkhash program).  Note that other strings might
  247.  * hash to valid hash values; we don't care or check
  248.  * for this because we know the client-server protocol
  249.  * process only writes valid entries in the file.
  250.  */
  251. const char* cmd = bp;
  252. HASH_DECLARE(hash);
  253. for (; *bp != ':' && *bp != 'n'; bp++)
  254. {
  255.     HASH_ITERATE(hash, *bp);
  256. }
  257. if (*bp != ':') { // invalid, skip line
  258.     error("Syntax error, missing ':' on line %u", (u_int) lineno);
  259.     while (*bp++ != 'n')
  260. ;
  261.     continue;
  262. }
  263. HASH_FINISH(hash);
  265. *bp++ = ''; // null-terminate cmd
  266. /*
  267.  * Collect the parameter value.
  268.  */
  269. while (*bp == ' ') // skip leading white space
  270.     bp++;
  271. char* tag = bp;
  272. while (*bp != 'n')
  273.     bp++;
  274. *bp++ = ''; // null-terminate tag
  275. // logError("%s[%u]: %s", cmd, hash, tag);
  276. switch (hash) {
  277. case H_EXTERNAL: external = tag; break;
  278. case H_CANONICAL: canonical = tag; break;
  279. case H_NUMBER: number = tag; break;
  280. case H_MAILADDR: mailaddr = tag; break;
  281. case H_SENDER: sender = tag; break;
  282. case H_JOBID: jobid = tag; break;
  283. case H_SERVERDOCOVER: serverdocover = tag[0] - '0'; break;
  284. case H_JOBTAG: jobtag = tag; break;
  285. case H_COMMID: commid = tag; break;
  286. case H_PAGEHANDLING: pagehandling = tag; break;
  287. case H_MODEM: modem = tag; break;
  288. case H_MODEMUSED: modemused = tag; break;
  289. case H_FAXNUMBER: faxnumber = tag; break;
  290. case H_FAXNAME: faxname = tag; break;
  291. case H_TSI: tsi = tag; break;
  292. case H_CSI: csi = tag; break;
  293. case H_RECEIVER: receiver = tag; break;
  294. case H_COMPANY: company = tag; break;
  295. case H_LOCATION: location = tag; break;
  296. case H_VOICE: voice = tag; break;
  297. case H_FROMLOCATION: fromlocation = tag; break;
  298. case H_FROMVOICE: fromvoice = tag; break;
  299. case H_REGARDING: regarding = tag; break;
  300. case H_COVER: cover = tag; break;
  301. case H_CLIENT: client = tag; break;
  302. case H_OWNER: owner = tag; break;
  303. case H_GROUPID: groupid = tag; break;
  304. case H_SIGNALRATE: sigrate = tag; break;
  305. case H_DATAFORMAT: df = tag; break;
  306. case H_JOBTYPE: jobtype = tag; break;
  307. case H_TAGLINE: tagline = tag; break;
  308. case H_TOTTRIES: tottries = atoi(tag); break;
  309. case H_SUBADDR: subaddr = tag; break;
  310. case H_PASSWD: passwd = tag; break;
  311. case H_STATE: state = tag[0] - '0'; break;
  312. case H_COMMENTS: comments = tag; break;
  313. case H_NPAGES: npages = atoi(tag); break;
  314. case H_FROMCOMPANY: fromcompany = tag; break;
  315. case H_TOTPAGES: totpages = atoi(tag); break;
  316. case H_NTRIES: ntries = atoi(tag); break;
  317. case H_MAXTRIES: maxtries = atoi(tag); break;
  318. case H_NDIALS: ndials = atoi(tag); break;
  319. case H_TOTDIALS: totdials = atoi(tag); break;
  320. case H_MAXDIALS: maxdials = atoi(tag); break;
  321. case H_PAGEWIDTH: pagewidth = atoi(tag); break;
  322. case H_RESOLUTION: resolution = atoi(tag); break;
  323. case H_PAGELENGTH: pagelength = atoi(tag); break;
  324. case H_PRIORITY: usrpri = atoi(tag); break;
  325. case H_SCHEDPRI: pri = atoi(tag); break;
  326. case H_SKIPPAGES: skippages = atoi(tag); break;
  327. case H_DESIREDBR: desiredbr = atoi(tag); break;
  328. case H_DESIREDST: desiredst = tag[0] - '0'; break;
  329. case H_DESIREDEC: desiredec = tag[0] - '0'; break;
  330. case H_SKIPPEDPAGES: skippedpages = atoi(tag); break;
  331. case H_DESIREDDF: desireddf = tag[0] - '0'; break;
  332. case H_DESIREDTL: desiredtl = tag[0] - '0'; break;
  333. case H_USECCOVER: useccover = tag[0] - '0'; break;
  334. case H_USEXVRES: usexvres = tag[0] - '0'; break;
  335. case H_IGNOREMODEMBUSY: ignoremodembusy = tag[0] - '0'; break;
  336. case H_TTS:
  337.     tts = atoi(tag);
  338.     if (tts == 0) // distinguish ``now'' from unset
  339. tts = Sys::now();
  340.     break;
  341. case H_NOCOUNTCOVER: nocountcover = atoi(tag); break;
  342. case H_KILLTIME: killtime = atoi(tag); break;
  343. case H_RETRYTIME: retrytime = atoi(tag); break;
  344. case H_NOTIFY: checkNotifyValue(tag); break;
  345. case H_PAGECHOP: checkChopValue(tag); break;
  346. case H_CHOPTHRESHOLD: chopthreshold = atof(tag); break;
  347. case H_NSF: nsf = tag; break;
  348. case H_TIMEOFDAY: timeofday = tag; break;
  349. case H_ERRORCODE: errorcode = tag; break;
  350. case H_DONEOP: doneop = tag; break;
  351. case H_RETURNED: status = (FaxSendStatus) atoi(tag); break;
  352. case H_MINBR: minbr = atoi(tag); break;
  354. case H_STATUS:
  355.     /*
  356.      * Check for multi-line status strings.
  357.      */
  358.     if (bp-tag > 1 && bp[-2] == '\') {
  359. *--bp = 'n'; // put back original n
  360. do {
  361.     lineno++, bp++;
  362.     while (*bp != 'n')
  363. bp++;
  364. } while (*bp == 'n' && bp > tag && bp[-1] == '\');
  365. *bp++ = '';
  366.     }
  367.     notice = tag;
  368.     break;
  371. case H_POLL: addItem(send_poll, tag); break;
  372. case H_FAX: addItem(send_fax, tag); break;
  373. case H_PDF:
  374.     if (cmd[0] == '!')
  375. addItem(send_pdf_saved, tag);
  376.     else
  377. addItem(send_pdf, tag, rejectJob);
  378.     break;
  379. case H_TIFF:
  380.     if (cmd[0] == '!')
  381. addItem(send_tiff_saved, tag);
  382.     else
  383. addItem(send_tiff, tag, rejectJob);
  384.     break;
  385. case H_POSTSCRIPT:
  386.     if (cmd[0] == '!')
  387. addItem(send_postscript_saved, tag);
  388.     else
  389. addItem(send_postscript, tag, rejectJob);
  390.     break;
  391. case H_PCL:
  392.     if (cmd[0] == '!')
  393. addItem(send_pcl_saved, tag);
  394.     else
  395. addItem(send_pcl, tag, rejectJob);
  396.     break;
  397. case H_DATA:
  398.     if (cmd[0] == '!')
  399. addItem(send_data_saved, tag);
  400.     else
  401. addItem(send_data, tag, rejectJob);
  402.     break;
  403. case H_PAGE:
  404.     if (cmd[0] == '!')
  405. addItem(send_page_saved, tag);
  406.     else
  407. addItem(send_page, tag);
  408.     break;
  409. default:
  410.     error("Unknown field %s[%u]: %s", cmd, hash, tag);
  411. }
  412.     } while (bp < ep);
  413.     if (pri == (u_short) -1)
  414. pri = usrpri;
  415.     if (tts == 0) // distinguish ``now'' from unset
  416. tts = Sys::now();
  417.     /*
  418.      * Validate certain items that are assumed to have
  419.      * ``suitable values'' by higher-level code (i.e.
  420.      * the scheduler).
  421.      */
  422.     if (state < state_suspended || state > state_failed) {
  423. error("Invalid scheduler state %u in job request", state);
  424. rejectJob = true;
  425.     }
  426. #define isNull(s) ((s).length() == 0)
  427.     if (isNull(number) || isNull(mailaddr) || isNull(sender) || isNull(jobid)
  428.      || isNull(modem)  || isNull(client)   || isNull(owner)) {
  429. rejectJob = true;
  430. error("Null or missing %s in job request",
  431.     isNull(number)   ? "number" :
  432.     isNull(mailaddr) ? "mailaddr" :
  433.     isNull(sender)   ? "sender" :
  434.     isNull(jobid)    ? "jobid" :
  435.     isNull(modem)    ? "modem" :
  436.     isNull(client)   ? "client" :
  437.        "owner"
  438. );
  439.     }
  440.     if (minbr > BR_33600) minbr = BR_33600;
  441.     if (desiredbr > BR_33600) desiredbr = BR_33600;
  442.     if (desiredst > ST_40MS) desiredst = ST_40MS;
  443.     if (desiredec > EC_ECLFULL) desiredec = EC_ECLFULL;
  444.     if (desireddf > DF_2DMMR) desireddf = DF_2DMMR;
  445.     if (buf != stackbuf) // dynamically allocated buffer
  446. delete [] buf;
  447.     return (true);
  448. }
  450. /*
  451.  * Re-read a job description file.
  452.  *
  453.  * Note that a file that has been written *should*
  454.  * have every entry set in it and so re-reading it
  455.  * will cause all fields to be written.  This means
  456.  * that we should not need to reset the state to the
  457.  * default values assigned when the instance is created;
  458.  * except for the items array which is dynamically
  459.  * allocated and appended to.  If you don't believe
  460.  * this, enable the code notdef'd out below.
  461.  */
  462. bool
  463. FaxRequest::reReadQFile(bool& rejectJob)
  464. {
  465. #ifdef notdef
  466.     reset(); // non-string items
  467.     for (int i = N(strvals)-1; i >= 0; i--) // string stuff
  468. (*this).*strvals[i].p = "";
  469. #endif
  470.     items.resize(0); // document/polling requests
  471.     return (readQFile(rejectJob));
  472. }
  474. #define DUMP(fp, vals, fmt, cast) {
  475.     for (u_int i = 0; i < N(vals); i++)
  476. sb.fput(fmt, vals[i].name, cast((*this).*vals[i].p));
  477. }
  479. /*
  480.  * Maybe write to temp and rename instead of
  481.  * updating in-place.  The files are so small
  482.  * however that we're unlikely to ever get ENOSPC
  483.  * when updating an existing file.  Also by using
  484.  * an existing file we avoid allocating a new
  485.  * disk block each time, instead overwriting the
  486.  * already allocated one.  This can be meaningful
  487.  * on a busy server given the potential number of
  488.  * times we update the q file.
  489.  */
  490. void
  491. FaxRequest::writeQFile()
  492. {
  493.     fxStackBuffer sb;
  494.     sb.fput("tts:%un", tts);
  495.     sb.fput("killtime:%un", killtime);
  496.     sb.fput("retrytime:%un", retrytime);
  497.     /*
  498.      * Pull errorcode out from notice.
  499.      */
  500.     u_int ecodestart = notice.find(0, "{");
  501.     u_int ecodeend = notice.find(ecodestart, "}");
  502.     if (ecodestart < notice.length() && ecodeend <= notice.length() && ecodeend == ecodestart + 5) {
  503. errorcode = notice.extract(ecodestart+1, 4);
  504. notice.remove(ecodestart, 6);
  505.     } else if (notice == "")
  506. errorcode = "";
  507.     DUMP(fp, shortvals, "%s:%dn", (int));
  508.     DUMP(fp, intvals, "%s:%dn", (int));
  509.     DUMP(fp, strvals, "%s:%sn", (const char*));
  510.     /*
  511.      * Escape unprotected n's with \.
  512.      */
  513.     sb.put("status:");
  514.     const char* cp = notice;
  515.     const char* sp = cp;
  516.     while (*cp) {
  517. if (*cp == 'n' && cp[-1] != '\') {
  518.    sb.put(sp, cp-sp);
  519.    sb.put('\');
  520.    sp = cp;
  521. }
  522. cp++;
  523.     }
  524.     sb.put(sp, cp-sp); sb.put('n');
  525.     sb.fput("returned:%dn", status);
  526.     sb.fput("notify:%sn", notifyVals[notify&3]);
  527.     sb.fput("pagechop:%sn", chopVals[pagechop&3]);
  528.     sb.fput("chopthreshold:%gn", chopthreshold);
  529.     for (u_int i = 0; i < items.length(); i++) {
  530. const FaxItem& fitem = items[i];
  531. sb.fput("%s:%u:%s:%sn"
  532.     , opNames[fitem.op&15]
  533.     , fitem.dirnum
  534.     , (const char*) fitem.addr
  535.     , (const char*) fitem.item
  536. );
  537.     }
  538.     lseek(fd, 0L, SEEK_SET);
  539.     Sys::write(fd, sb, sb.getLength());
  540.     int ignore = ftruncate(fd, sb.getLength());
  541.     // XXX maybe should fsync, but not especially portable
  542. }
  544. /*
  545.  * Return the base document name given a
  546.  * per-job document name (either with a
  547.  * jobid suffix or, if a cover page, with
  548.  * a ``.cover'' suffix).
  549.  */
  550. fxStr
  551. FaxRequest::mkbasedoc(const fxStr& file)
  552. {
  553.     fxStr doc(file);
  554.     u_int l = doc.nextR(doc.length(), '.');
  555.     doc.resize(l-1);
  556.     return (doc);
  557. }
  559. /*
  560.  * Check if a document that is about to be removed from
  561.  * the job request was converted from another.  If so,
  562.  * rename the source document according to convention
  563.  * so that all references to the document point to the
  564.  * same file when everything has been sent.  This has the
  565.  * effect of decrementing the link count on the source
  566.  * file and permits us to use the link count as a reference
  567.  * use count for releasing imaged documents (see the
  568.  * large comments explaining this in the scheduler).
  569.  */
  570. void
  571. FaxRequest::renameSaved(u_int fi)
  572. {
  573.     if (fi > 0 && items[fi-1].isSavedOp()) {
  574. FaxItem& src = items[fi-1];
  575. fxStr basedoc = mkbasedoc(src.item);
  576. if (Sys::rename(src.item, basedoc) < 0) {
  577.     logError("Unable to rename transmitted document %s: %s",
  578. (const char*) src.item, strerror(errno));
  579. }
  580. // Posix rename will succeed without doing anything if the
  581. // source and destination files are hard linked
  582. Sys::unlink(src.item); // just remove it
  583. src.item = basedoc; // change job reference
  584.     }
  585. }
  587. /*
  588.  * Does the specified document (assumed to be send_fax)
  589.  * appear to have any potential source references?
  590.  */
  591. bool
  592. FaxRequest::isUnreferenced(u_int fi)
  593. {
  594.     if (fi > 0 && items[fi-1].isSavedOp()) {
  595. struct stat sb;
  596. if (Sys::stat(mkbasedoc(items[fi-1].item), sb) < 0 ||
  597.   sb.st_nlink == 1)
  598.     return (true);
  599.     }
  600.     return (false);
  601. }
  603. static bool
  604. hasDotDot(const char* pathname)
  605. {
  606.     const char* cp = pathname;
  607.     while (cp) {
  608. if (cp[0] == '.') // NB: good enough
  609.     return (true);
  610. if ((cp = strchr(cp, '/')))
  611.     cp++;
  612.     }
  613.     return (false);
  614. }
  616. bool
  617. FaxRequest::checkDocument(const char* pathname)
  618. {
  619.     /*
  620.      * Scan full pathname to disallow access to
  621.      * files outside the spooling hiearchy.
  622.      */
  623.     if (pathname[0] == '/' || hasDotDot(pathname)) {
  624. error("Invalid document file "%s"", pathname);
  625. return (false);
  626.     }
  627.     int fd = Sys::open(pathname, 0);
  628.     if (fd == -1) {
  629. error("Can not access document file "%s": %s",
  630.     pathname, strerror(errno));
  631. return (false);
  632.     }
  633.     Sys::close(fd);
  634.     return (true);
  635. }
  637. /*
  638.  * Add a request entry that does not require checking
  639.  * the document pathname to make sure that it is valid.
  640.  */
  641. void
  642. FaxRequest::addItem(FaxSendOp op, char* tag)
  643. {
  644.     char* cp = tag;
  645.     while (*cp && *cp != ':')
  646. cp++;
  647.     int dirnum;
  648.     if (*cp == ':') { // directory index
  649. dirnum = atoi(tag);
  650. tag = ++cp;
  651.     } else
  652. dirnum = 0;
  653.     while (*cp && *cp != ':')
  654. cp++;
  655.     if (*cp == ':') // address info
  656. *cp++ = '';
  657.     else
  658. cp = tag, tag = '';
  659.     items.append(FaxItem(op, dirnum, tag, cp));
  660. }
  662. /*
  663.  * Add a request entry and verify the document is valid.
  664.  */
  665. void
  666. FaxRequest::addItem(FaxSendOp op, char* tag, bool& rejectJob)
  667. {
  668.     char* cp = tag;
  669.     while (*cp && *cp != ':')
  670. cp++;
  671.     int dirnum;
  672.     if (*cp == ':') { // directory index
  673. dirnum = atoi(tag);
  674. tag = ++cp;
  675.     } else
  676. dirnum = 0;
  677.     while (*cp && *cp != ':')
  678. cp++;
  679.     if (*cp == ':') // address info
  680. *cp++ = '';
  681.     else
  682. cp = tag, tag = '';
  683.     if (!checkDocument(cp)) {
  684.      error("Rejected document in corrupt job request");
  685. rejectJob = true;
  686.     }
  687.     else
  688. items.append(FaxItem(op, dirnum, tag, cp));
  689. }
  691. bool
  692. FaxRequest::isStrCmd(const char* cmd, u_int& ix)
  693. {
  694.     for (int i = N(strvals)-1; i >= 0; i--)
  695. if (strcmp(strvals[i].name, cmd) == 0) {
  696.     ix = i;
  697.     return (true);
  698. }
  699.     return (false);
  700. }
  702. bool
  703. FaxRequest::isShortCmd(const char* cmd, u_int& ix)
  704. {
  705.     for (int i = N(shortvals)-1; i >= 0; i--)
  706. if (strcmp(shortvals[i].name, cmd) == 0) {
  707.     ix = i;
  708.     return (true);
  709. }
  710.     return (false);
  711. }
  713. bool
  714. FaxRequest::isIntCmd(const char* cmd, u_int& ix)
  715. {
  716.     for (int i = N(intvals)-1; i >= 0; i--)
  717. if (strcmp(intvals[i].name, cmd) == 0) {
  718.     ix = i;
  719.     return (true);
  720. }
  721.     return (false);
  722. }
  724. void
  725. FaxRequest::checkNotifyValue(const char* tag)
  726. {
  727.     for (int i = N(notifyVals)-1; i >= 0; i--)
  728.  if (strcmp(notifyVals[i], tag) == 0) {
  729.     notify = i;
  730.     return;
  731. }
  732.     error("Invalid notify value "%s"", tag);
  733. }
  735. void
  736. FaxRequest::checkChopValue(const char* tag)
  737. {
  738.     for (int i = N(chopVals)-1; i >= 0; i--)
  739.  if (strcmp(chopVals[i], tag) == 0) {
  740.     pagechop = i;
  741.     return;
  742. }
  743.     error("Invalid pagechop value "%s"", tag);
  744. }
  746. u_int
  747. FaxRequest::findItem(FaxSendOp op, u_int ix) const
  748. {
  749.     while (ix < items.length()) {
  750. if (items[ix].op == op)
  751.     return (ix);
  752. ix++;
  753.     }
  754.     return fx_invalidArrayIndex;
  755. }
  757. void
  758. FaxRequest::insertFax(u_int ix, const fxStr& file)
  759. {
  760.     items.insert(FaxItem(send_fax, 0, fxStr::null, file), ix);
  761. }
  763. void
  764. FaxRequest::error(const char* fmt0 ...)
  765. {
  766.     fxStr fmt = fxStr::format("%s: line %u: %s", (const char*) qfile, (u_int) lineno, fmt0);
  767.     va_list ap;
  768.     va_start(ap, fmt0);
  769.     vlogError(fmt, ap);
  770.     va_end(ap);
  771. }